ServiceTitan Component

ServiceTitan is a comprehensive field service management solution that helps businesses manage their operations, workforce, and customer service.

Component key: servicetitan

Description

ServiceTitan is a comprehensive field service management solution that helps businesses manage their operations, workforce, and customer service.

Use the ServiceTitan component to manage Technicians, Jobs, Appointments, and more.

API Documentation: ServiceTitan API Reference

Connections

OAuth 2.0

To authenticate ServiceTitan integrations with OAuth 2.0 requires a developer account and the configuration of an application from the ServiceTitan Developer Portal.

To Create an app:

1. Login to the Developer Portal
2. Select My Apps at the top of the page
3. Select + New App
4. Fill all the required fields and scopes
5. Under Client Credentials Management”, select I, the app developer, will configure the credentials on behalf of each tenant
6. Click Create App

For Existing apps:

1. Login to the Developer Portal
2. Select My Apps at the top of the page
3. Click Edit on your application
4. Under Client Credentials Management”, select I, the app developer, will configure the credentials on behalf of each tenant
5. Click Save

To obtain a Client Secret and Client ID:

If you haven’t done so already, please add the client’s Tenant ID to your application. Once the Tenant Admin has allowed access and connected to your application through their “API Application Access” settings, you can begin the process of obtaining the tenant’s client ID and client secret in your developer portal:

1. Login to the Developer Portal
2. Select My Apps at the top of the page
3. Click View Connections for your app
4. Click Generate under Client Secret to create a new Client Secret
5. Reference the tenant’s Client ID on this page as well

Input	Notes	Example
Application Key string / Required applicationKey	The ID of the payment.	ak1.4adsy4lzgsd0b3cqh48zl5z3d7
Authorize URL string Hidden Field authorizeUrl	The OAuth 2.0 Authorization URL for the API
Client ID string / Required clientId	Client Identifier of your app for the API
Client Secret password / Required clientSecret	Client Secret of your app for the API
Environment string / Required environment	The environment to connect to
Scopes string Hidden Field scopes	Space separated OAuth 2.0 permission scopes for the API
Tenant string / Required tenant	The client tenant.	10978752986
Token URL string / Required tokenUrl	The OAuth 2.0 Token URL for the API

Data Sources

Select Appointment

Select an Appointment from a dropdown menu (up to 10,000 Appointments) | key: selectAppointment | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Appointment

{
  "result": [
    {
      "key": "1",
      "label": "#1 (ID: 1)"
    }
  ]
}

---

Select Booking

Select a booking from a dropdown menu (up to 10,000 bookings) | key: selectBooking | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Booking

{
  "result": [
    {
      "key": "1",
      "label": "Booking 1 (ID: 1)"
    },
    {
      "key": "2",
      "label": "Booking 2 (ID: 2)"
    }
  ]
}

---

Select Customer

Select a customer from a dropdown menu (up to 10,000 customers) | key: selectCustomers | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Customer

{
  "result": [
    {
      "key": "1",
      "label": "John Doe (ID: 1)"
    },
    {
      "key": "2",
      "label": "Jane Doe (ID: 2)"
    }
  ]
}

---

Select Installed Equipment

Select an Installed Equipment from a dropdown menu (up to 10,000 Installed Equipments) | key: selectInstalledEquipment | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Installed Equipment

{
  "result": [
    {
      "key": "1",
      "label": "Installed Equipment 1 (ID: 1)"
    },
    {
      "key": "2",
      "label": "Installed Equipment 2 (ID: 2)"
    }
  ]
}

---

Select Invoice

Select an Invoice from a dropdown menu (up to 10,000 Invoices) | key: selectInvoice | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Invoice

{
  "result": [
    {
      "key": "1",
      "label": "#1234"
    }
  ]
}

---

Select Job

Select a job from a dropdown menu (up to 10,000 jobs) | key: selectJob | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Job

{
  "result": [
    {
      "key": "1",
      "label": "#1"
    },
    {
      "key": "2",
      "label": "#2"
    },
    {
      "key": "3",
      "label": "#3"
    }
  ]
}

---

Select Location

Select a Location from a dropdown menu (up to 10,000 Locations) | key: selectLocation | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Location

{
  "result": [
    {
      "key": "1",
      "label": "Location 1 (ID: 1)"
    },
    {
      "key": "2",
      "label": "Location 2 (ID: 2)"
    },
    {
      "key": "3",
      "label": "Location 3 (ID: 3)"
    }
  ]
}

---

Select Project

Select a Project from a dropdown menu (up to 10,000 Projects) | key: selectProject | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Project

{
  "result": [
    {
      "key": "1",
      "label": "Project 1 (ID: 1)"
    },
    {
      "key": "2",
      "label": "Project 2 (ID: 2)"
    }
  ]
}

---

Select Technician

Select a Technician from a dropdown menu (up to 10,000 Technicians) | key: selectTechnician | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Technician

{
  "result": [
    {
      "key": "1",
      "label": "John Doe (ID: 1)"
    },
    {
      "key": "2",
      "label": "Jane Doe (ID: 2)"
    }
  ]
}

---

Actions

Assign Technician to Appointment

Assigns the list of technicians to the appointment | key: assignTechnicians

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Job Appointment ID string / Required jobAppointmentId		ID of the job appointment	1234567890
Technician IDs string / Required Value List technicianIds		Assign these technicians to the appointment.	1088

Example Payload for Assign Technician to Appointment

{
  "data": {
    "id": 0,
    "jobId": 0,
    "appointmentNumber": "string",
    "start": "string",
    "end": "string",
    "arrivalWindowStart": "string",
    "arrivalWindowEnd": "string",
    "status": {},
    "specialInstructions": "string",
    "createdOn": "string",
    "modifiedOn": "string"
  }
}

---

Cancel Job

Cancels a Job | key: cancelJob

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Job ID string / Required jobId		The job ID.	10978752986
Job Memo text / Required memo		Memo of job cancel reason	string
Reason ID string / Required reasonId		ID of job cancel reason	1088

Example Payload for Cancel Job

{
  "data": {}
}

---

Create Appointment

Adds a new appointment to an existing job | key: createAppointment

Input	Default	Notes	Example
Arrival Window End string arrivalWindowEnd		Arrival window end date/time (in UTC)	2021-01-01T00:00:00Z
Arrival Window Start string arrivalWindowStart		Arrival window start date/time (in UTC)	2021-01-01T00:00:00Z
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
End string / Required end		End date/time (in UTC)	2021-01-01T00:00:00Z
Job ID string / Required jobId		The job ID.	10978752986
Special Instructions text specialInstructions		Special instructions associated to the appointment	Any special instructions
Start string / Required start		Start date/time (in UTC)	2021-01-01T00:00:00Z
Technician ID string technicianId		The ID of the technician.	10978752986

Example Payload for Create Appointment

{
  "data": {
    "id": 0,
    "jobId": 0,
    "appointmentNumber": "string",
    "start": "string",
    "end": "string",
    "arrivalWindowStart": "string",
    "arrivalWindowEnd": "string",
    "status": {},
    "specialInstructions": "string",
    "createdOn": "string",
    "modifiedOn": "string",
    "customerId": 0,
    "unused": true
  }
}

---

Create Booking by Provider

Create a booking | key: createBookingByProvider

Input	Default	Notes	Example
Address code address		Address of the booking
Booking Provider string / Required bookingProvider		The ID of the booking provider.	10978752986
Business Unit ID string businessUnitId		ID of the booking's business unit	10978752986
Campaign ID string campaignId		ID of the booking's campaign	10978752986
Connection connection / Required connection
Contacts code contacts		Contacts for the booking
Customer Type string customerType		Type of the customer
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External ID string / Required externalId		External ID of booking	10978752986
Is First Time Client string / Required isFirstTimeClient		True if first time client
Send Confirmation Email string isSendConfirmationEmail		True if first time client
Job Type ID string jobTypeId		ID of the booking's job type	10978752986
Name string / Required name		Booking name	Test Source
Priority string priority		Booking priority
Source string / Required source		The source of the booking provider	Test Source
Start string start		Start date/time (in UTC)	2021-01-01T00:00:00Z
Summary string / Required summary		Summary of the booking	A summary related to the invoice.
Uploaded Images string Value List uploadedImages		Uploaded images

Example Payload for Create Booking by Provider

{
  "data": {
    "id": 0,
    "source": "string",
    "createdOn": "string",
    "name": "string",
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string"
    },
    "customerType": {},
    "start": "string",
    "summary": "string",
    "campaignId": 0,
    "businessUnitId": 0,
    "isFirstTimeClient": true,
    "uploadedImages": [
      "string"
    ],
    "isSendConfirmationEmail": true,
    "status": {},
    "dismissingReasonId": 0,
    "jobId": 0,
    "externalId": "string",
    "priority": {},
    "jobTypeId": 0,
    "bookingProviderId": 0,
    "modifiedOn": "string"
  }
}

---

Create Customer

Create a New Customer | key: createCustomer

Input	Default	Notes	Example
Address code / Required address		Bill-To address of the customer record
Connection connection / Required connection
Contacts code contacts		Contacts for the booking
Custom Fields code customFields		Custom fields for the request
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Do Not Mail string doNotMail		Customer has been flagged as “do not mail”
Do Not Service string doNotService		Customer has been flagged as “do not service”
External Data code externalData		External data to attach to the request.
Location code / Required locations		Locations for the customer
Name string / Required name		Name of the customer	Test Source
Tag Type IDs string Value List tagTypeIds		A list of tags ID's	123
Customer Type string type		Type of the customer

Example Payload for Create Customer

{
  "data": {
    "id": 0,
    "active": true,
    "name": "string",
    "type": {},
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    },
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "balance": 0,
    "tagTypeIds": [
      0
    ],
    "doNotMail": true,
    "doNotService": true,
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "mergedToId": 0,
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "locations": [
      {
        "taxZoneId": 0,
        "id": 0,
        "customerId": 0,
        "active": true,
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string",
          "latitude": 0,
          "longitude": 0
        },
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "mergedToId": 0,
        "zoneId": 0,
        "tagTypeIds": [
          0
        ],
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "contacts": [
          {
            "id": 0,
            "type": {},
            "value": "string",
            "memo": "string"
          }
        ]
      }
    ],
    "contacts": [
      {
        "id": 0,
        "type": {},
        "value": "string",
        "memo": "string"
      }
    ]
  }
}

---

Create Customer Contact

Create a contact for a customer | key: createCustomerContact

Input	Default	Notes	Example
Connection connection / Required connection
Customer ID string / Required customerId		The customer ID.	10978752986
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Memo string memo		Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly”	Payment for services rendered.
Customer Contact Type string / Required type		Type of the customer contact
Customer Contact Type Value string / Required value		The email, phone number, or fax number for the contact	1234567890

Example Payload for Create Customer Contact

{
  "data": {
    "id": 0,
    "type": {},
    "value": "string",
    "memo": "string",
    "modifiedOn": "string",
    "phoneSettings": {
      "phoneNumber": "string",
      "doNotText": true
    }
  }
}

---

Create Installed Equipment

Create a new Installed equipment | key: createInstalledEquipment

Input	Default	Notes	Example
Attachments code attachments		List of attachments
Connection connection / Required connection
Cost string cost		Cost of the installed equipment	100.00
Custom Fields code customFields		The custom fields of the installed equipment
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Installed On string installedOn		The date the equipment was installed	2021-01-01T00:00:00Z
Location ID string / Required locationId		The location id of the installed equipment	10978752986
Manufacturer string manufacturer		Manufacturer of the installed equipment	Test Manufacturer
Manufacturer Warranty End string manufacturerWarrantyEnd		Manufacturer warranty end date	2021-01-01T00:00:00Z
Manufacturer Warranty Start string manufacturerWarrantyStart		Manufacturer warranty start date	2021-01-01T00:00:00Z
Memo string memo		The memo of the installed equipment	Payment for services rendered.
Model string model		Model of the installed equipment	Test Model
Name string name		The name of the installed equipment	Test Source
Serial Number string serialNumber		Serial number of the installed equipment	1234567890
Service Provider Warranty End string serviceProviderWarrantyEnd		Service Provider Warranty End date	2021-01-01T00:00:00Z
Service Provider Warranty Start string serviceProviderWarrantyStart		Service Provider Warranty Start date	2021-01-01T00:00:00Z
Tag Type IDs string Value List tagTypeIds		A list of tags ID's	123

Example Payload for Create Installed Equipment

{
  "data": {
    "id": 0,
    "equipmentId": 0,
    "locationId": 0,
    "customerId": 0,
    "invoiceItemId": 0,
    "name": "string",
    "installedOn": "string",
    "createdOn": "string",
    "modifiedOn": "string",
    "serialNumber": "string",
    "memo": "string",
    "manufacturer": "string",
    "model": "string",
    "cost": 0,
    "manufacturerWarrantyStart": "string",
    "manufacturerWarrantyEnd": "string",
    "serviceProviderWarrantyStart": "string",
    "serviceProviderWarrantyEnd": "string",
    "tags": [
      {
        "id": 0,
        "ownerId": 0,
        "typeId": 0,
        "typeName": "string",
        "memo": "string",
        "color": "string",
        "textColor": "string",
        "code": "string"
      }
    ],
    "customFields": [
      {
        "id": 0,
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "attachments": [
      {
        "alias": "string",
        "fileName": "string",
        "type": {},
        "url": "string"
      }
    ]
  }
}

---

Create Installed Equipment Attachment

Create a new installed equipment attachment | key: createInstalledEquipmentAttachment

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Attachment File data / Required file		Reference a file from another action. Must be a file type.
File Name string / Required fileName		Name of the file	Test File

Example Payload for Create Installed Equipment Attachment

{
  "data": {
    "path": "InstalledEquipment/Documents/e2374d0c-16b8-4bb7-b3b5-1bd0ac1df1f4.csv"
  }
}

---

Create Invoices

Create adjustment invoice | key: createInvoices

Input	Default	Notes	Example
Adjustment To ID string / Required adjustmentToId		The ID of the invoice the adjustment is for.	10978752986
Assigned To ID string assignedToId		The ID of the user the invoice is assigned to.	10978752986
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Export ID string exportId		Gets or sets the identifier when exported.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Invoiced On string invoicedOn		The date the invoice was invoiced on.	2021-01-01T00:00:00Z
Items code items		The items of the invoice.
Number string number		The invoice number.	10978752986
Review Status string reviewStatus		The review status of the invoice.
Royalty Date string royaltyDate		The royalty date of the invoice.	2021-01-01T00:00:00Z
Royalty Memo string royaltyMemo		The royalty sent date of the invoice.	Payment for services rendered.
Royalty Sent On string royaltySentOn		The royalty sent date of the invoice.	2021-01-01T00:00:00Z
Royalty Status string royaltyStatus		The royalty status of the invoice.
Subtotal string subtotal		The subtotal of the invoice.	100.00
Summary string summary		The summary of the invoice.	A summary related to the invoice.
Tax string tax		The tax of the invoice.	100.00
Type ID string typeId		The ID of the type of the payment.	0

Example Payload for Create Invoices

{
  "data": {}
}

---

Create Job

Create a job | key: createJob

Input	Default	Notes	Example
Appointments code / Required appointments		List of appointment information
Business Unit ID string / Required businessUnitId		ID of the job's business unit	10978752986
Campaign ID string / Required campaignId		ID of the job's campaign	10978752986
Connection connection / Required connection
Customer ID string / Required customerId		The customer ID.	10978752986
Customer PO string customerPo		Customer PO
Custom Fields code customFields		Custom fields for the job
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External Data code externalData		External data to attach to the request.
Invoice Signature Is Required string invoiceSignatureIsRequired		Optional model that informs if invoice should requires a signature or not if not informed will follow the rules for location and job type
Job Generated Lead Source code jobGeneratedLeadSource		Object that contains: JobId: ID of the job from which this job was generated EmployeeId: ID of the office user or technician
Job Type ID string / Required jobTypeId		ID of the job's type	10978752986
Location ID string / Required locationId		The ID of the location.	10978752986
Priority string / Required priority		Priority of the job
Project ID string projectId		ID of the job's project	10978752986
Summary string summary		Job summary	A summary related to the invoice.
Tag Type IDs string Value List tagTypeIds		Tag type IDs for the job	123

Example Payload for Create Job

{
  "data": {
    "id": 0,
    "jobNumber": "string",
    "projectId": 0,
    "customerId": 0,
    "locationId": 0,
    "jobStatus": "string",
    "completedOn": "string",
    "businessUnitId": 0,
    "jobTypeId": 0,
    "priority": "string",
    "campaignId": 0,
    "summary": "string",
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "appointmentCount": 0,
    "firstAppointmentId": 0,
    "lastAppointmentId": 0,
    "recallForId": 0,
    "warrantyId": 0,
    "jobGeneratedLeadSource": {
      "jobId": 0,
      "employeeId": 0
    },
    "noCharge": true,
    "notificationsEnabled": true,
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "tagTypeIds": [
      0
    ],
    "leadCallId": 0,
    "bookingId": 0,
    "soldById": 0,
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "customerPo": "string"
  }
}

---

Create Location

Creates a new location | key: createLocation

Input	Default	Notes	Example
Address code / Required address		The address of the location
Connection connection / Required connection
Contacts code contacts		The contacts associated with the location
Customer ID string / Required customerId		The customer ID.	10978752986
Custom Fields code customFields		Custom fields for the request
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External Data code externalData		External data to attach to the request.
Name string / Required name		The name of the location	Test Source
Tag Type IDs string Value List tagTypeIds		A list of tags ID's	123

Example Payload for Create Location

{
  "data": {
    "id": 0,
    "customerId": 0,
    "active": true,
    "name": "string",
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    },
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "mergedToId": 0,
    "zoneId": 0,
    "tagTypeIds": [
      0
    ],
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "taxZoneId": 0,
    "contacts": [
      {
        "id": 0,
        "type": {},
        "value": "string",
        "memo": "string"
      }
    ]
  }
}

---

Create Payment

Create a payment in Service Titan | key: createPayment

Input	Default	Notes	Example
Auth Code string authCode		The authorization code for the payment.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Check Number string checkNumber		The check number for the payment.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Export ID string exportId		Gets or sets the identifier when exported.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Memo string memo		The memo of the payment.	Payment for services rendered.
Paid On string paidOn		The date the payment was paid on.	2021-01-01T00:00:00Z
Splits code / Required splits		The splits of the payment.
Status string status		The status of the payment.
Type ID string / Required typeId		The ID of the type of the payment.	0

Example Payload for Create Payment

{
  "data": {
    "id": 0,
    "typeId": 0,
    "active": true,
    "memo": "string",
    "paidOn": "string",
    "authCode": "string",
    "checkNumber": "string",
    "exportId": "string",
    "transactionStatus": {},
    "status": {},
    "splits": [
      {
        "invoiceId": 0,
        "amount": 0
      }
    ]
  }
}

---

Create Project

Create a new project | key: createProject

Input	Default	Notes	Example
Actual Completion Date string actualCompletionDate		Actual completion date of the project	2021-01-01T00:00:00Z
Connection connection / Required connection
Customer ID string customerId		ID of the project's customer	10978752986
Custom Fields code customFields		Custom fields for the project
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External Data code externalData		Optional model that contains a list of external data items that should be attached to this project.
Location ID string / Required locationId		The ID of the location.	10978752986
Name string name		Name of the project	Test Source
Project Manager IDs string Value List projectManagerIds		IDs of the project's managers	1088
Start string startDate		Start date of the project	2021-01-01T00:00:00Z
Status ID string statusId		Project status id	1088
Sub Status ID string subStatusId		Project sub status id	1088
Summary string summary		Summary of the project	A summary related to the invoice.
Target Completion Date string targetCompletionDate		Target completion date of the project	2021-01-01T00:00:00Z

Example Payload for Create Project

{
  "data": {
    "id": 0,
    "number": "string",
    "name": "string",
    "summary": "string",
    "status": "string",
    "statusId": 0,
    "subStatus": "string",
    "subStatusId": 0,
    "customerId": 0,
    "locationId": 0,
    "projectManagerIds": [
      0
    ],
    "businessUnitIds": [
      0
    ],
    "startDate": "string",
    "targetCompletionDate": "string",
    "actualCompletionDate": "string",
    "modifiedOn": "string",
    "createdOn": "string",
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "jobIds": [
      0
    ]
  }
}

---

Create Technician

Create new technician | key: createTechnician

Input	Default	Notes	Example
Azure Active Directory User Id string aadUserId		Azure Active Directory User Id	6B29FC40-CA47-1067-B31D-00DD010662DA
Account Creation Method string / Required accountCreationMethod		Account creation method
Biography string bio		Biography of the technician	Biography
Burden Rate string burdenRate		Burden rate (hourly)	5.6
Business Unit ID string businessUnitId		The ID of the business unit to which the technician will be assigned	10978752986
Connection connection / Required connection
Custom Fields code customFields		Custom fields for the technician
Daily Goal string dailyGoal		Daily revenue goal	5.6
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Email string email		Technician's email address	test@technician.us
Address code home		The home address of the technician
Job Filter string jobFilter		Upcoming appointment visibility
Job History Date Filter string jobHistoryDateFilter		Appointment history visibility
License Type string / Required licenseType		License type
Login Username string login		Technician's username	technician_us
Memo string memo		Memo for the technician	Payment for services rendered.
Name string / Required name		The name of the technician	Test Source
Password string password		Technician's password	@an1pwd123
Phone Number string phoneNumber		Technician's phone number	1234567890
Positions string / Required Value List positions		List of company positions
Role ID string / Required roleId		User role Id	7
Team string team		Team name	Test Team

Example Payload for Create Technician

{
  "data": {
    "id": 0
  }
}

---

Delete Appointment

Delete appointment by ID | key: deleteAppointment

Input	Default	Notes	Example
Appointment ID string / Required appointmentId		The ID of the appointment.	10978752986
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Example Payload for Delete Appointment

{
  "data": {}
}

---

Delete Customer Contact

Removes a contact from a customer | key: deletCustomersContact

Input	Default	Notes	Example
Connection connection / Required connection
Customer Contact ID string / Required customerContactId		The customer contact ID.	10978752986
Customer ID string / Required customerId		The customer ID.	10978752986
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Example Payload for Delete Customer Contact

{
  "data": {}
}

---

Delete Invoice Item

Delete an invoice item | key: deleteInvoiceItem

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Invoice ID string / Required invoiceId		The ID of the invoice.	10978752986
Item ID string / Required itemId		The ID of the item.	10978752986

Example Payload for Delete Invoice Item

{
  "data": {}
}

---

Get Appointment

Retrieve an appointment by ID | key: getAppointment

Input	Default	Notes	Example
Appointment ID string / Required appointmentId		The ID of the appointment.	10978752986
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Example Payload for Get Appointment

{
  "data": {
    "id": 0,
    "jobId": 0,
    "appointmentNumber": "string",
    "start": "string",
    "end": "string",
    "arrivalWindowStart": "string",
    "arrivalWindowEnd": "string",
    "status": {},
    "specialInstructions": "string",
    "createdOn": "string",
    "modifiedOn": "string",
    "customerId": 0,
    "unused": true
  }
}

---

Get Booking by Provider

Retrieve a booking by ID | key: getBookingByProvider

Input	Default	Notes	Example
Booking ID string / Required bookingId		The ID of the booking.	10978752986
Booking Provider string / Required bookingProvider		The ID of the booking provider.	10978752986
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Example Payload for Get Booking by Provider

{
  "data": {
    "id": 0,
    "source": "string",
    "createdOn": "string",
    "name": "string",
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string"
    },
    "customerType": {},
    "start": "string",
    "summary": "string",
    "campaignId": 0,
    "businessUnitId": 0,
    "isFirstTimeClient": true,
    "uploadedImages": [
      "string"
    ],
    "isSendConfirmationEmail": true,
    "status": {},
    "dismissingReasonId": 0,
    "jobId": 0,
    "externalId": "string",
    "priority": {},
    "jobTypeId": 0,
    "bookingProviderId": 0,
    "modifiedOn": "string"
  }
}

---

Get Booking by Tenant

Retrieve a booking by ID | key: getBookingByTenant

Input	Default	Notes	Example
Booking ID string / Required bookingId		The ID of the booking.	10978752986
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Example Payload for Get Booking by Tenant

{
  "data": {
    "id": 0,
    "source": "string",
    "createdOn": "string",
    "name": "string",
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string"
    },
    "customerType": {},
    "start": "string",
    "summary": "string",
    "campaignId": 0,
    "businessUnitId": 0,
    "isFirstTimeClient": true,
    "uploadedImages": [
      "string"
    ],
    "isSendConfirmationEmail": true,
    "status": {},
    "dismissingReasonId": 0,
    "jobId": 0,
    "externalId": "string",
    "priority": {},
    "jobTypeId": 0,
    "bookingProviderId": 0,
    "modifiedOn": "string"
  }
}

---

Get Customer

Retrieve a Customer by ID | key: getCustomer

Input	Default	Notes	Example
Connection connection / Required connection
Customer ID string / Required customerId		The customer ID.	10978752986
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Example Payload for Get Customer

{
  "data": {
    "id": 0,
    "active": true,
    "name": "string",
    "type": {},
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    },
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "balance": 0,
    "tagTypeIds": [
      0
    ],
    "doNotMail": true,
    "doNotService": true,
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "mergedToId": 0,
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

---

Get Installed Equipment

Retrieve a Installed Equipment by ID | key: getInstalledEquipment

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Installed Equipment ID string / Required installedEquipmentId		ID of the installed equipment	1234567890

Example Payload for Get Installed Equipment

{
  "data": {
    "id": 0,
    "equipmentId": 0,
    "locationId": 0,
    "customerId": 0,
    "invoiceItemId": 0,
    "name": "string",
    "installedOn": "string",
    "createdOn": "string",
    "modifiedOn": "string",
    "serialNumber": "string",
    "memo": "string",
    "manufacturer": "string",
    "model": "string",
    "cost": 0,
    "manufacturerWarrantyStart": "string",
    "manufacturerWarrantyEnd": "string",
    "serviceProviderWarrantyStart": "string",
    "serviceProviderWarrantyEnd": "string",
    "tags": [
      {
        "id": 0,
        "ownerId": 0,
        "typeId": 0,
        "typeName": "string",
        "memo": "string",
        "color": "string",
        "textColor": "string",
        "code": "string"
      }
    ],
    "customFields": [
      {
        "id": 0,
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "attachments": [
      {
        "alias": "string",
        "fileName": "string",
        "type": {},
        "url": "string"
      }
    ]
  }
}

---

Get Job

Retrieve a job by ID | key: getJob

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External Data Application Guid string externalDataApplicationGuid		Format - guid. If this guid is provided, external data corresponding to this application guid will be returned.	6B29FC40-CA47-1067-B31D-00DD010662DA
Job ID string / Required jobId		The job ID.	10978752986

Example Payload for Get Job

{
  "data": {
    "id": 0,
    "jobNumber": "string",
    "projectId": 0,
    "customerId": 0,
    "locationId": 0,
    "jobStatus": "string",
    "completedOn": "string",
    "businessUnitId": 0,
    "jobTypeId": 0,
    "priority": "string",
    "campaignId": 0,
    "summary": "string",
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "appointmentCount": 0,
    "firstAppointmentId": 0,
    "lastAppointmentId": 0,
    "recallForId": 0,
    "warrantyId": 0,
    "jobGeneratedLeadSource": {
      "jobId": 0,
      "employeeId": 0
    },
    "noCharge": true,
    "notificationsEnabled": true,
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "tagTypeIds": [
      0
    ],
    "leadCallId": 0,
    "bookingId": 0,
    "soldById": 0,
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "customerPo": "string"
  }
}

---

Get Location

Retrieve a location by ID | key: getLocation

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Location ID string / Required locationId		The ID of the location to retrieve	10978752986

Example Payload for Get Location

{
  "data": {
    "id": 0,
    "customerId": 0,
    "active": true,
    "name": "string",
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    },
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "mergedToId": 0,
    "zoneId": 0,
    "tagTypeIds": [
      0
    ],
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "taxZoneId": 0
  }
}

---

Get Project

Retrieve a project by ID | key: getProject

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Project ID string / Required projectId		The ID of the project to retrieve	10978752986

Example Payload for Get Project

{
  "data": {
    "id": 0,
    "number": "string",
    "name": "string",
    "summary": "string",
    "status": "string",
    "statusId": 0,
    "subStatus": "string",
    "subStatusId": 0,
    "customerId": 0,
    "locationId": 0,
    "projectManagerIds": [
      0
    ],
    "businessUnitIds": [
      0
    ],
    "startDate": "string",
    "targetCompletionDate": "string",
    "actualCompletionDate": "string",
    "modifiedOn": "string",
    "createdOn": "string",
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "jobIds": [
      0
    ]
  }
}

---

Get Technician

Retrieve a Technician by ID | key: getTechnician

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Technician ID string / Required technicianId		The ID of the Technician to retrieve	10978752986

Example Payload for Get Technician

{
  "data": {
    "id": 0,
    "userId": 0,
    "name": "string",
    "roleIds": [
      0
    ],
    "businessUnitId": 0,
    "mainZoneId": 0,
    "zoneIds": [
      0
    ],
    "createdOn": "string",
    "modifiedOn": "string",
    "email": "string",
    "phoneNumber": "string",
    "loginName": "string",
    "home": {
      "street": "string",
      "unit": "string",
      "country": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "streetAddress": "string",
      "latitude": 0,
      "longitude": 0
    },
    "dailyGoal": 0,
    "isManagedTech": true,
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "active": true,
    "aadUserId": "string",
    "burdenRate": 0,
    "team": "string",
    "jobFilter": {}
  }
}

---

List Appointment Assignment

Retrieve a list of appointment assignments | key: listAppointmentsAssignment

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Appointment Assignment

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "technicianId": 0,
        "technicianName": "string",
        "assignedById": 0,
        "assignedOn": "string",
        "status": {},
        "isPaused": true,
        "jobId": 0,
        "appointmentId": 0
      }
    ]
  }
}

---

List Appointments

Retrieve a list of appointments | key: listAppointments

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Appointments

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "jobId": 0,
        "appointmentNumber": "string",
        "start": "string",
        "end": "string",
        "arrivalWindowStart": "string",
        "arrivalWindowEnd": "string",
        "status": {},
        "specialInstructions": "string",
        "createdOn": "string",
        "modifiedOn": "string",
        "customerId": 0,
        "unused": true
      },
      {
        "id": 0,
        "jobId": 0,
        "appointmentNumber": "string",
        "start": "string",
        "end": "string",
        "arrivalWindowStart": "string",
        "arrivalWindowEnd": "string",
        "status": {},
        "specialInstructions": "string",
        "createdOn": "string",
        "modifiedOn": "string",
        "customerId": 0,
        "unused": true
      }
    ]
  }
}

---

List Bookings by Provider

Retrieves a list of bookings | key: listBookingByProvider

Input	Default	Notes	Example
Booking Provider string / Required bookingProvider		The ID of the booking provider.	10978752986
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Bookings by Provider

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "source": "string",
        "createdOn": "string",
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "customerType": {},
        "start": "string",
        "summary": "string",
        "campaignId": 0,
        "businessUnitId": 0,
        "isFirstTimeClient": true,
        "uploadedImages": [
          "string"
        ],
        "isSendConfirmationEmail": true,
        "status": {},
        "dismissingReasonId": 0,
        "jobId": 0,
        "externalId": "string",
        "priority": {},
        "jobTypeId": 0,
        "bookingProviderId": 0,
        "modifiedOn": "string"
      },
      {
        "id": 0,
        "source": "string",
        "createdOn": "string",
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "customerType": {},
        "start": "string",
        "summary": "string",
        "campaignId": 0,
        "businessUnitId": 0,
        "isFirstTimeClient": true,
        "uploadedImages": [
          "string"
        ],
        "isSendConfirmationEmail": true,
        "status": {},
        "dismissingReasonId": 0,
        "jobId": 0,
        "externalId": "string",
        "priority": {},
        "jobTypeId": 0,
        "bookingProviderId": 0,
        "modifiedOn": "string"
      }
    ]
  }
}

---

List Bookings by Tenant

Retrieves a list of bookings | key: listBookingByTenant

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Bookings by Tenant

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "source": "string",
        "createdOn": "string",
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "customerType": {},
        "start": "string",
        "summary": "string",
        "campaignId": 0,
        "businessUnitId": 0,
        "isFirstTimeClient": true,
        "uploadedImages": [
          "string"
        ],
        "isSendConfirmationEmail": true,
        "status": {},
        "dismissingReasonId": 0,
        "jobId": 0,
        "externalId": "string",
        "priority": {},
        "jobTypeId": 0,
        "bookingProviderId": 0,
        "modifiedOn": "string"
      },
      {
        "id": 0,
        "source": "string",
        "createdOn": "string",
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "customerType": {},
        "start": "string",
        "summary": "string",
        "campaignId": 0,
        "businessUnitId": 0,
        "isFirstTimeClient": true,
        "uploadedImages": [
          "string"
        ],
        "isSendConfirmationEmail": true,
        "status": {},
        "dismissingReasonId": 0,
        "jobId": 0,
        "externalId": "string",
        "priority": {},
        "jobTypeId": 0,
        "bookingProviderId": 0,
        "modifiedOn": "string"
      }
    ]
  }
}

---

List Business Units

Gets a list of business units | key: listBusinessUnits

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Business Units

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "active": true,
        "name": "string",
        "officialName": "string",
        "email": "string",
        "currency": "string",
        "phoneNumber": "string",
        "invoiceHeader": "string",
        "invoiceMessage": "string",
        "defaultTaxRate": 0,
        "authorizationParagraph": "string",
        "acknowledgementParagraph": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "materialSku": "string",
        "quickbooksClass": "string",
        "accountCode": "string",
        "franchiseId": "string",
        "conceptCode": "string",
        "corporateContractNumber": "string",
        "tenant": {
          "id": 0,
          "name": "string",
          "accountCode": "string",
          "franchiseId": "string",
          "conceptCode": "string",
          "modifiedOn": "string"
        },
        "createdOn": "string",
        "modifiedOn": "string",
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}

---

List Customer Contacts

Gets a list of contacts for the specified customer | key: listCustomersContact

Input	Default	Notes	Example
Connection connection / Required connection
Customer ID string / Required customerId		The customer ID.	10978752986
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Modified Before string modifiedBefore		Return items modified before certain date/time (in UTC)	2021-01-01T00:00:00Z
Modified On Or After string modifiedOnOrAfter		Return items modified on or after certain date/time (in UTC)	2021-01-01T00:00:00Z
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50

Example Payload for List Customer Contacts

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "type": {},
        "value": "string",
        "memo": "string",
        "modifiedOn": "string",
        "phoneSettings": {
          "phoneNumber": "string",
          "doNotText": true
        }
      },
      {
        "id": 0,
        "type": {},
        "value": "string",
        "memo": "string",
        "modifiedOn": "string",
        "phoneSettings": {
          "phoneNumber": "string",
          "doNotText": true
        }
      }
    ]
  }
}

---

List Customers

Retrieve a list of Customers | key: listCustomers

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Customers

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "active": true,
        "name": "string",
        "type": {},
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string",
          "latitude": 0,
          "longitude": 0
        },
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "balance": 0,
        "tagTypeIds": [
          0
        ],
        "doNotMail": true,
        "doNotService": true,
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "mergedToId": 0,
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      },
      {
        "id": 0,
        "active": true,
        "name": "string",
        "type": {},
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string",
          "latitude": 0,
          "longitude": 0
        },
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "balance": 0,
        "tagTypeIds": [
          0
        ],
        "doNotMail": true,
        "doNotService": true,
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "mergedToId": 0,
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}

---

List Installed Equipment

Retrieve a list of installed equipment | key: listInstalledEquipment

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Installed Equipment

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "equipmentId": 0,
        "locationId": 0,
        "customerId": 0,
        "invoiceItemId": 0,
        "name": "string",
        "installedOn": "string",
        "createdOn": "string",
        "modifiedOn": "string",
        "serialNumber": "string",
        "memo": "string",
        "manufacturer": "string",
        "model": "string",
        "cost": 0,
        "manufacturerWarrantyStart": "string",
        "manufacturerWarrantyEnd": "string",
        "serviceProviderWarrantyStart": "string",
        "serviceProviderWarrantyEnd": "string",
        "tags": [
          {
            "id": 0,
            "ownerId": 0,
            "typeId": 0,
            "typeName": "string",
            "memo": "string",
            "color": "string",
            "textColor": "string",
            "code": "string"
          }
        ]
      }
    ]
  }
}

---

List Installed Equipment Attachments

Retrieve installed Equipment attachments | key: listInstalledEquipmentAttachments

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Path string / Required path		Installed equipment attachment path	department

Example Payload for List Installed Equipment Attachments

{
  "data": {
    "type": "Buffer",
    "data": [
      69,
      120,
      97,
      109,
      112,
      108,
      101,
      70,
      105,
      108,
      101
    ]
  }
}

---

List Invoices

Retrieves a list of invoices | key: listInvoices

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Invoices

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "syncStatus": "string",
        "summary": "string",
        "referenceNumber": "string",
        "invoiceDate": "string",
        "dueDate": "string",
        "subTotal": "string",
        "salesTax": "string",
        "salesTaxCode": {
          "id": 0,
          "name": "string",
          "taxRate": 0
        },
        "total": "string",
        "balance": "string",
        "invoiceType": {
          "id": 0,
          "name": "string"
        },
        "customer": {
          "id": 0,
          "name": "string"
        },
        "customerAddress": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "location": {
          "id": 0,
          "name": "string"
        },
        "locationAddress": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "businessUnit": {
          "id": 0,
          "name": "string"
        },
        "termName": "string",
        "createdBy": "string",
        "batch": {
          "id": 0,
          "number": "string",
          "name": "string"
        },
        "depositedOn": "string",
        "createdOn": "string",
        "modifiedOn": "string",
        "adjustmentToId": 0,
        "job": {
          "id": 0,
          "number": "string",
          "type": "string"
        },
        "projectId": 0,
        "royalty": {
          "status": "string",
          "date": "string",
          "sentOn": "string",
          "memo": "string"
        },
        "employeeInfo": {
          "id": 0,
          "name": "string",
          "modifiedOn": "string"
        },
        "commissionEligibilityDate": "string",
        "sentStatus": "NotSent",
        "reviewStatus": "NeedsReview",
        "assignedTo": {
          "id": 0,
          "name": "string"
        },
        "items": [
          {
            "id": 0,
            "description": "string",
            "quantity": "string",
            "cost": "string",
            "totalCost": "string",
            "inventoryLocation": "string",
            "price": "string",
            "type": "Service",
            "skuName": "string",
            "skuId": 0,
            "total": "string",
            "inventory": true,
            "taxable": true,
            "generalLedgerAccount": {
              "id": 0,
              "name": "string",
              "number": "string",
              "type": "string",
              "detailType": "string"
            },
            "costOfSaleAccount": {
              "id": 0,
              "name": "string",
              "number": "string",
              "type": "string",
              "detailType": "string"
            },
            "assetAccount": {
              "id": 0,
              "name": "string",
              "number": "string",
              "type": "string",
              "detailType": "string"
            },
            "membershipTypeId": 0,
            "itemGroup": {
              "rootId": 0,
              "name": "string"
            },
            "displayName": "string",
            "soldHours": 0,
            "modifiedOn": "string",
            "serviceDate": "string",
            "order": 0,
            "businessUnit": {
              "id": 0,
              "name": "string"
            }
          }
        ],
        "customFields": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      {
        "id": 0,
        "syncStatus": "string",
        "summary": "string",
        "referenceNumber": "string",
        "invoiceDate": "string",
        "dueDate": "string",
        "subTotal": "string",
        "salesTax": "string",
        "salesTaxCode": {
          "id": 0,
          "name": "string",
          "taxRate": 0
        },
        "total": "string",
        "balance": "string",
        "invoiceType": {
          "id": 0,
          "name": "string"
        },
        "customer": {
          "id": 0,
          "name": "string"
        },
        "customerAddress": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "location": {
          "id": 0,
          "name": "string"
        },
        "locationAddress": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string"
        },
        "businessUnit": {
          "id": 0,
          "name": "string"
        },
        "termName": "string",
        "createdBy": "string",
        "batch": {
          "id": 0,
          "number": "string",
          "name": "string"
        },
        "depositedOn": "string",
        "createdOn": "string",
        "modifiedOn": "string",
        "adjustmentToId": 0,
        "job": {
          "id": 0,
          "number": "string",
          "type": "string"
        },
        "projectId": 0,
        "royalty": {
          "status": "string",
          "date": "string",
          "sentOn": "string",
          "memo": "string"
        },
        "employeeInfo": {
          "id": 0,
          "name": "string",
          "modifiedOn": "string"
        },
        "commissionEligibilityDate": "string",
        "sentStatus": "NotSent",
        "reviewStatus": "NeedsReview",
        "assignedTo": {
          "id": 0,
          "name": "string"
        },
        "items": [
          {
            "id": 0,
            "description": "string",
            "quantity": "string",
            "cost": "string",
            "totalCost": "string",
            "inventoryLocation": "string",
            "price": "string",
            "type": "Service",
            "skuName": "string",
            "skuId": 0,
            "total": "string",
            "inventory": true,
            "taxable": true,
            "generalLedgerAccount": {
              "id": 0,
              "name": "string",
              "number": "string",
              "type": "string",
              "detailType": "string"
            },
            "costOfSaleAccount": {
              "id": 0,
              "name": "string",
              "number": "string",
              "type": "string",
              "detailType": "string"
            },
            "assetAccount": {
              "id": 0,
              "name": "string",
              "number": "string",
              "type": "string",
              "detailType": "string"
            },
            "membershipTypeId": 0,
            "itemGroup": {
              "rootId": 0,
              "name": "string"
            },
            "displayName": "string",
            "soldHours": 0,
            "modifiedOn": "string",
            "serviceDate": "string",
            "order": 0,
            "businessUnit": {
              "id": 0,
              "name": "string"
            }
          }
        ],
        "customFields": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}

---

List Job Cancel Reasons

Retrieve a list of job cancel reasons | key: listJobCancelReasons

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Job Cancel Reasons

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "name": "string",
        "active": true,
        "createdOn": "string",
        "modifiedOn": "string"
      }
    ]
  }
}

---

List Jobs

Retrieve a list of jobs | key: listJobs

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Jobs

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "jobNumber": "string",
        "projectId": 0,
        "customerId": 0,
        "locationId": 0,
        "jobStatus": "string",
        "completedOn": "string",
        "businessUnitId": 0,
        "jobTypeId": 0,
        "priority": "string",
        "campaignId": 0,
        "summary": "string",
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "appointmentCount": 0,
        "firstAppointmentId": 0,
        "lastAppointmentId": 0,
        "recallForId": 0,
        "warrantyId": 0,
        "jobGeneratedLeadSource": {
          "jobId": 0,
          "employeeId": 0
        },
        "noCharge": true,
        "notificationsEnabled": true,
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "tagTypeIds": [
          0
        ],
        "leadCallId": 0,
        "bookingId": 0,
        "soldById": 0,
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "customerPo": "string"
      },
      {
        "id": 0,
        "jobNumber": "string",
        "projectId": 0,
        "customerId": 0,
        "locationId": 0,
        "jobStatus": "string",
        "completedOn": "string",
        "businessUnitId": 0,
        "jobTypeId": 0,
        "priority": "string",
        "campaignId": 0,
        "summary": "string",
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "appointmentCount": 0,
        "firstAppointmentId": 0,
        "lastAppointmentId": 0,
        "recallForId": 0,
        "warrantyId": 0,
        "jobGeneratedLeadSource": {
          "jobId": 0,
          "employeeId": 0
        },
        "noCharge": true,
        "notificationsEnabled": true,
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "tagTypeIds": [
          0
        ],
        "leadCallId": 0,
        "bookingId": 0,
        "soldById": 0,
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "customerPo": "string"
      }
    ]
  }
}

---

List Locations

Retrieve a list of Locations | key: listLocations

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Locations

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "customerId": 0,
        "active": true,
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string",
          "latitude": 0,
          "longitude": 0
        },
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "mergedToId": 0,
        "zoneId": 0,
        "tagTypeIds": [
          0
        ],
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "taxZoneId": 0
      },
      {
        "id": 0,
        "customerId": 0,
        "active": true,
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string",
          "latitude": 0,
          "longitude": 0
        },
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "mergedToId": 0,
        "zoneId": 0,
        "tagTypeIds": [
          0
        ],
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "taxZoneId": 0
      }
    ]
  }
}

---

List Payments

Retrieve a list of payments | key: listPayments

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Payments

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "syncStatus": "string",
        "referenceNumber": "string",
        "date": "string",
        "type": "string",
        "typeId": "string",
        "total": "string",
        "unappliedAmount": "string",
        "memo": "string",
        "customer": {
          "id": 0,
          "name": "string"
        },
        "businessUnit": {
          "id": 0,
          "name": "string"
        },
        "batch": {
          "id": 0,
          "number": "string",
          "name": "string"
        },
        "createdBy": "string",
        "generalLedgerAccount": {
          "id": 0,
          "name": "string",
          "number": "string",
          "type": "string",
          "detailType": "string"
        },
        "appliedTo": [
          {
            "appliedId": 0,
            "appliedTo": 0,
            "appliedAmount": "string",
            "appliedOn": "string",
            "appliedBy": "string",
            "appliedToReferenceNumber": "string"
          }
        ],
        "customFields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "authCode": "string",
        "checkNumber": "string",
        "modifiedOn": "string",
        "createdOn": "string"
      }
    ]
  }
}

---

List Projects

Retrieve a list of Projects | key: listProjects

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Projects

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "number": "string",
        "name": "string",
        "summary": "string",
        "status": "string",
        "statusId": 0,
        "subStatus": "string",
        "subStatusId": 0,
        "customerId": 0,
        "locationId": 0,
        "projectManagerIds": [
          0
        ],
        "businessUnitIds": [
          0
        ],
        "startDate": "string",
        "targetCompletionDate": "string",
        "actualCompletionDate": "string",
        "modifiedOn": "string",
        "createdOn": "string",
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "jobIds": [
          0
        ]
      },
      {
        "id": 0,
        "number": "string",
        "name": "string",
        "summary": "string",
        "status": "string",
        "statusId": 0,
        "subStatus": "string",
        "subStatusId": 0,
        "customerId": 0,
        "locationId": 0,
        "projectManagerIds": [
          0
        ],
        "businessUnitIds": [
          0
        ],
        "startDate": "string",
        "targetCompletionDate": "string",
        "actualCompletionDate": "string",
        "modifiedOn": "string",
        "createdOn": "string",
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "jobIds": [
          0
        ]
      }
    ]
  }
}

---

List Technicians

Retrieve a list of technicians | key: listTechnicians

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List Technicians

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "userId": 0,
        "name": "string",
        "roleIds": [
          0
        ],
        "businessUnitId": 0,
        "mainZoneId": 0,
        "zoneIds": [
          0
        ],
        "createdOn": "string",
        "modifiedOn": "string",
        "email": "string",
        "phoneNumber": "string",
        "loginName": "string",
        "home": {
          "street": "string",
          "unit": "string",
          "country": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "streetAddress": "string",
          "latitude": 0,
          "longitude": 0
        },
        "dailyGoal": 0,
        "isManagedTech": true,
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "active": true,
        "aadUserId": "string",
        "burdenRate": 0,
        "team": "string",
        "jobFilter": {}
      },
      {
        "id": 0,
        "userId": 0,
        "name": "string",
        "roleIds": [
          0
        ],
        "businessUnitId": 0,
        "mainZoneId": 0,
        "zoneIds": [
          0
        ],
        "createdOn": "string",
        "modifiedOn": "string",
        "email": "string",
        "phoneNumber": "string",
        "loginName": "string",
        "home": {
          "street": "string",
          "unit": "string",
          "country": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "streetAddress": "string",
          "latitude": 0,
          "longitude": 0
        },
        "dailyGoal": 0,
        "isManagedTech": true,
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "active": true,
        "aadUserId": "string",
        "burdenRate": 0,
        "team": "string",
        "jobFilter": {}
      }
    ]
  }
}

---

List User Roles

Gets a list of user roles | key: listUserRoles

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, fetch all records, if false, will use the pageSize and page parameters
Include Total boolean includeTotal	false	Include total count of records. If fetchAll is true, this will be ignored.
Page string page		The page number to filter by	1
Page Size string pageSize		How many records to return (50 by default)	50
Sort string sort		Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order.	+FieldName

Example Payload for List User Roles

{
  "data": {
    "page": 0,
    "pageSize": 0,
    "hasMore": true,
    "totalCount": 0,
    "data": [
      {
        "id": 0,
        "active": true,
        "name": "string",
        "createdOn": "string",
        "employeeType": "Employee"
      }
    ]
  }
}

---

Raw Request

Send raw HTTP request to ServiceDesk Plus | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enable this to log the request and response
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/jobs), The base URL is already included (https://api.servicetitan.io/jpm/v2/{YOUR-TENANT}/). For example, to connect to https://api.servicetitan.io/jpm/v2/{YOUR-TENANT}/jobs, only /jobs is entered in this field. e.g. /jobs	/jobs
URL Type string / Required urlType		The URL type to connect to. For example, jpm, crm, accounting, etc.	jpm
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

---

Unassign Technician to Appointment

Un-assigns the list of technicians from the appointment | key: unassignTechnicians

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Job Appointment ID string / Required jobAppointmentId		ID of the job appointment	1234567890
Technician IDs string / Required Value List technicianIds		Unassign these technicians to the appointment.	1088

Example Payload for Unassign Technician to Appointment

{
  "data": {
    "id": 0,
    "jobId": 0,
    "appointmentNumber": "string",
    "start": "string",
    "end": "string",
    "arrivalWindowStart": "string",
    "arrivalWindowEnd": "string",
    "status": {},
    "specialInstructions": "string",
    "createdOn": "string",
    "modifiedOn": "string"
  }
}

---

Update Booking

Update a booking | key: updateBooking

Input	Default	Notes	Example
Address code address		Address of the booking
Booking ID string / Required bookingId		The ID of the booking.	10978752986
Booking Provider string / Required bookingProvider		The ID of the booking provider.	10978752986
Business Unit ID string businessUnitId		ID of the booking's business unit	10978752986
Campaign ID string campaignId		ID of the booking's campaign	10978752986
Connection connection / Required connection
Customer Type string customerType		Type of the customer
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External ID string externalId		External ID of booking	10978752986
Is First Time Client string isFirstTimeClient		True if first time client
Job Type ID string jobTypeId		ID of the booking's job type	10978752986
Name string name		Name of the customer	Test Source
Priority string priority		Booking priority
Source string source		The source of the booking provider	Test Source
Start string start		Start date/time (in UTC)	2021-01-01T00:00:00Z
Summary string summary		Summary of the booking	A summary related to the invoice.
Uploaded Images string Value List uploadedImages		Uploaded images

Example Payload for Update Booking

{
  "data": {
    "id": 0,
    "source": "string",
    "createdOn": "string",
    "name": "string",
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string"
    },
    "customerType": {},
    "start": "string",
    "summary": "string",
    "campaignId": 0,
    "businessUnitId": 0,
    "isFirstTimeClient": true,
    "uploadedImages": [
      "string"
    ],
    "isSendConfirmationEmail": true,
    "status": {},
    "dismissingReasonId": 0,
    "jobId": 0,
    "externalId": "string",
    "priority": {},
    "jobTypeId": 0,
    "bookingProviderId": 0,
    "modifiedOn": "string"
  }
}

---

Update Customer

Update a customer | key: updateCustomer

Input	Default	Notes	Example
Active string active		Whether the customer is active
Address code address		Address of the booking
Connection connection / Required connection
Customer ID string / Required customerId		The customer ID.	10978752986
Custom Fields code customFields		Custom fields for the request
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Do Not Mail string doNotMail		Customer has been flagged as “do not mail”
Do Not Service string doNotService		Customer has been flagged as “do not service”
External Data code externalData		External data to attach to the request.
Name string name		Name of the customer	Test Source
Tag Type IDs string Value List tagTypeIds		A list of tags ID's	123
Customer Type string type		Type of the customer

Example Payload for Update Customer

{
  "data": {
    "id": 0,
    "active": true,
    "name": "string",
    "type": {},
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    },
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "balance": 0,
    "tagTypeIds": [
      0
    ],
    "doNotMail": true,
    "doNotService": true,
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "mergedToId": 0,
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "locations": [
      {
        "taxZoneId": 0,
        "id": 0,
        "customerId": 0,
        "active": true,
        "name": "string",
        "address": {
          "street": "string",
          "unit": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string",
          "latitude": 0,
          "longitude": 0
        },
        "customFields": [
          {
            "typeId": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "createdOn": "string",
        "createdById": 0,
        "modifiedOn": "string",
        "mergedToId": 0,
        "zoneId": 0,
        "tagTypeIds": [
          0
        ],
        "externalData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "contacts": [
          {
            "id": 0,
            "type": {},
            "value": "string",
            "memo": "string"
          }
        ]
      }
    ],
    "contacts": [
      {
        "id": 0,
        "type": {},
        "value": "string",
        "memo": "string"
      }
    ]
  }
}

---

Update Customer Contact

Updates a contact on the customers | key: updateCustomerContact

Input	Default	Notes	Example
Connection connection / Required connection
Customer Contact ID string / Required customerContactId		The customer contact ID.	10978752986
Customer ID string / Required customerId		The customer ID.	10978752986
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Memo string memo		Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly”	Payment for services rendered.
Customer Contact Type string type		Type of the customer contact
Customer Contact Type Value string value		The email, phone number, or fax number for the contact	1234567890

Example Payload for Update Customer Contact

{
  "data": {
    "id": 0,
    "type": {},
    "value": "string",
    "memo": "string",
    "modifiedOn": "string",
    "phoneSettings": {
      "phoneNumber": "string",
      "doNotText": true
    }
  }
}

---

Update Installed Equipment

Update installed equipment by ID | key: updateInstalledEquipment

Input	Default	Notes	Example
Attachments code attachments		List of attachments
Connection connection / Required connection
Cost string cost		Cost of the installed equipment	100.00
Custom Fields code customFields		The custom fields of the installed equipment
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Installed Equipment ID string / Required installedEquipmentId		ID of the installed equipment	1234567890
Installed On string installedOn		The date the equipment was installed	2021-01-01T00:00:00Z
Manufacturer string manufacturer		Manufacturer of the installed equipment	Test Manufacturer
Manufacturer Warranty End string manufacturerWarrantyEnd		Manufacturer warranty end date	2021-01-01T00:00:00Z
Manufacturer Warranty Start string manufacturerWarrantyStart		Manufacturer warranty start date	2021-01-01T00:00:00Z
Memo string memo		The memo of the installed equipment	Payment for services rendered.
Model string model		Model of the installed equipment	Test Model
Name string name		The name of the installed equipment	Test Source
Serial Number string serialNumber		Serial number of the installed equipment	1234567890
Service Provider Warranty End string serviceProviderWarrantyEnd		Service Provider Warranty End date	2021-01-01T00:00:00Z
Service Provider Warranty Start string serviceProviderWarrantyStart		Service Provider Warranty Start date	2021-01-01T00:00:00Z
Tag Type IDs string Value List tagTypeIds		A list of tags ID's	123

Example Payload for Update Installed Equipment

{
  "data": {
    "id": 0,
    "equipmentId": 0,
    "locationId": 0,
    "customerId": 0,
    "invoiceItemId": 0,
    "name": "string",
    "installedOn": "string",
    "createdOn": "string",
    "modifiedOn": "string",
    "serialNumber": "string",
    "memo": "string",
    "manufacturer": "string",
    "model": "string",
    "cost": 0,
    "manufacturerWarrantyStart": "string",
    "manufacturerWarrantyEnd": "string",
    "serviceProviderWarrantyStart": "string",
    "serviceProviderWarrantyEnd": "string",
    "tags": [
      {
        "id": 0,
        "ownerId": 0,
        "typeId": 0,
        "typeName": "string",
        "memo": "string",
        "color": "string",
        "textColor": "string",
        "code": "string"
      }
    ],
    "customFields": [
      {
        "id": 0,
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "attachments": [
      {
        "alias": "string",
        "fileName": "string",
        "type": {},
        "url": "string"
      }
    ]
  }
}

---

Update Invoice

Update Invoice | key: updateInvoice

Input	Default	Notes	Example
Assigned To ID string assignedToId		The ID of the user the invoice is assigned to.	10978752986
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Export ID string exportId		Gets or sets the identifier when exported.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Invoiced On string invoicedOn		The date the invoice was invoiced on.	2021-01-01T00:00:00Z
Invoice ID string / Required invoiceId		The ID of the invoice.	10978752986
Items code items		The items of the invoice.
Number string number		The invoice number.	10978752986
Payments code payments		The payments of the invoice.
Review Status string reviewStatus		The review status of the invoice.
Royalty Date string royaltyDate		The royalty date of the invoice.	2021-01-01T00:00:00Z
Royalty Memo string royaltyMemo		The royalty sent date of the invoice.	Payment for services rendered.
Royalty Sent On string royaltySentOn		The royalty sent date of the invoice.	2021-01-01T00:00:00Z
Royalty Status string royaltyStatus		The royalty status of the invoice.
Subtotal string subtotal		The subtotal of the invoice.	100.00
Summary string summary		The summary of the invoice.	A summary related to the invoice.
Tax string tax		The tax of the invoice.	100.00
Type ID string typeId		The ID of the type of the payment.	0

Example Payload for Update Invoice

{
  "data": {}
}

---

Update Invoice Custom Fields

Update custom fields for specified Invoices | key: updateInvoiceCustomFields

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Operations code / Required operations		The operations to perform on the invoice.

Example Payload for Update Invoice Custom Fields

{
  "data": {}
}

---

Update Invoice Items

Update invoice items | key: updateInvoiceItems

Input	Default	Notes	Example
Connection connection / Required connection
Cost string cost		The cost of the SKU.	2.0
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Description string / Required description		The description of the SKU.	A test SKU
Duration Billing ID string durationBillingId		The duration billing ID of the SKU.	10978752986
ID string id		The ID.	10978752986
Installed On string installedOn		The date the SKU was installed on.	2021-01-01T00:00:00Z
Inventory Location ID string inventoryLocationId		The inventory location ID of the SKU.	10978752986
Inventory Warehouse Name string inventoryWarehouseName		The inventory warehouse name of the SKU.	Warehouse
Invoice ID string / Required invoiceId		The ID of the invoice.	10978752986
Is Add On string isAddOn		Is the SKU an add on.
Item Group Name string itemGroupName		The item group name of the SKU.	Test Group
Item Group Root ID string itemGroupRootId		The item group root ID of the SKU.	10978752986
Quantity string / Required quantity		The quantity of the SKU.	2
Signature string signature		The signature of the SKU.	An example signature.
Skip Updating Membership Prices string skipUpdatingMembershipPrices		Skip updating membership prices.
SKU ID string skuId		The ID of the SKU.	10978752986
SKU Name string skuName		The name of the SKU.	Test SKU
Technician Acknowledgement Signature string technicianAcknowledgementSignature		The technician acknowledgement signature of the SKU.	Test Signature
Technician ID string technicianId		The ID of the technician.	10978752986
Unit Price string unitPrice		The unit price of the SKU.	2.0

Example Payload for Update Invoice Items

{
  "data": {}
}

---

Update Job

Update a job | key: updateJob

Input	Default	Notes	Example
Business Unit ID string businessUnitId		ID of the job's business unit	10978752986
Campaign ID string campaignId		ID of the job's campaign	10978752986
Connection connection / Required connection
Customer ID string customerId		The customer ID.	10978752986
Customer PO string customerPo		Customer PO
Custom Fields code customFields		Custom fields for the job
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External Data code externalData		External data to attach to the request.
Job Generated Lead Source code jobGeneratedLeadSource		Object that contains: JobId: ID of the job from which this job was generated EmployeeId: ID of the office user or technician
Job ID string / Required jobId		The job ID.	10978752986
Job Type ID string jobTypeId		ID of the job's type	10978752986
Location ID string locationId		The ID of the location.	10978752986
Priority string priority		Priority of the job
Should Update Invoice Items string shouldUpdateInvoiceItems		If set to true, update the business unit of invoice items on job's invoice
Summary string summary		Job summary	A summary related to the invoice.
Tag Type IDs string Value List tagTypeIds		Tag type IDs for the job	123

Example Payload for Update Job

{
  "data": {
    "id": 0,
    "jobNumber": "string",
    "projectId": 0,
    "customerId": 0,
    "locationId": 0,
    "jobStatus": "string",
    "completedOn": "string",
    "businessUnitId": 0,
    "jobTypeId": 0,
    "priority": "string",
    "campaignId": 0,
    "summary": "string",
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "appointmentCount": 0,
    "firstAppointmentId": 0,
    "lastAppointmentId": 0,
    "recallForId": 0,
    "warrantyId": 0,
    "jobGeneratedLeadSource": {
      "jobId": 0,
      "employeeId": 0
    },
    "noCharge": true,
    "notificationsEnabled": true,
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "tagTypeIds": [
      0
    ],
    "leadCallId": 0,
    "bookingId": 0,
    "soldById": 0,
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "customerPo": "string"
  }
}

---

Update Location

Update a location | key: updateLocation

Input	Default	Notes	Example
Active string active		If false, the location will be marked as inactive
Address code address		The address of the location
Connection connection / Required connection
Customer ID string customerId		The customer ID associated with the location	10978752986
Custom Fields code customFields		Custom fields for the request
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External Data code externalData		External data to attach to the request.
Location ID string / Required locationId		The ID of the location.	10978752986
Name string name		The name of the location	Test Source
Tag Type IDs string Value List tagTypeIds		A list of tags ID's	123
Tax Zone ID string taxZoneId		ID of the location tax zone	1088

Example Payload for Update Location

{
  "data": {
    "id": 0,
    "customerId": 0,
    "active": true,
    "name": "string",
    "address": {
      "street": "string",
      "unit": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    },
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "createdOn": "string",
    "createdById": 0,
    "modifiedOn": "string",
    "mergedToId": 0,
    "zoneId": 0,
    "tagTypeIds": [
      0
    ],
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "taxZoneId": 0
  }
}

---

Update Payment

Update a specified payment | key: updatePayment

Input	Default	Notes	Example
Auth Code string authCode		The authorization code for the payment.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Check Number string checkNumber		The check number for the payment.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Export ID string exportId		Gets or sets the identifier when exported.	6B29FC40-CA47-1067-B31D-00DD010662DA21323
Memo string memo		The memo of the payment.	Payment for services rendered.
Paid On string paidOn		The date the payment was paid on.	2021-01-01T00:00:00Z
Payment ID string / Required paymentId		The ID of the payment.	10978752986
Splits code / Required splits		The splits of the payment.
Status string status		The status of the payment.
Type ID string / Required typeId		The ID of the type of the payment.	0

Example Payload for Update Payment

{
  "data": {
    "id": 0,
    "typeId": 0,
    "active": true,
    "memo": "string",
    "paidOn": "string",
    "authCode": "string",
    "checkNumber": "string",
    "exportId": "string",
    "transactionStatus": {},
    "status": {},
    "splits": [
      {
        "invoiceId": 0,
        "amount": 0
      }
    ]
  }
}

---

Update Payment Custom Fields

Update custom fields for specified payments | key: updatePaymentCustomFields

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Operations code / Required operations		The operations to perform on the payment.

Example Payload for Update Payment Custom Fields

{
  "data": {}
}

---

Update Project

Update a project | key: updateProject

Input	Default	Notes	Example
Actual Completion Date string actualCompletionDate		Actual completion date of the project	2021-01-01T00:00:00Z
Connection connection / Required connection
Custom Fields code customFields		Custom fields for the project
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External Data code externalData		Optional model that contains a list of external data items that should be attached to this project.
Jobs IDs string Value List jobsIds		IDs of the project's jobs	1088
Name string name		Name of the project	Test Source
Project ID string / Required projectId		ID of the project to update	10978752986
Project Manager IDs string Value List projectManagerIds		IDs of the project's managers	1088
Start string startDate		Start date of the project	2021-01-01T00:00:00Z
Status ID string statusId		Project status id	1088
Sub Status ID string subStatusId		Project sub status id	1088
Summary string summary		Summary of the project	A summary related to the invoice.
Target Completion Date string targetCompletionDate		Target completion date of the project	2021-01-01T00:00:00Z

Example Payload for Update Project

{
  "data": {
    "id": 0,
    "number": "string",
    "name": "string",
    "summary": "string",
    "status": "string",
    "statusId": 0,
    "subStatus": "string",
    "subStatusId": 0,
    "customerId": 0,
    "locationId": 0,
    "projectManagerIds": [
      0
    ],
    "businessUnitIds": [
      0
    ],
    "startDate": "string",
    "targetCompletionDate": "string",
    "actualCompletionDate": "string",
    "modifiedOn": "string",
    "createdOn": "string",
    "customFields": [
      {
        "typeId": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "externalData": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "jobIds": [
      0
    ]
  }
}

---

Update Technician

Update a technician | key: updateTechnician

Input	Default	Notes	Example
Azure Active Directory User Id string aadUserId		Azure Active Directory User Id	6B29FC40-CA47-1067-B31D-00DD010662DA
Biography string bio		Biography of the technician	Biography
Burden Rate string burdenRate		Burden rate (hourly)	5.6
Business Unit ID string businessUnitId		The ID of the business unit to which the technician will be assigned	10978752986
Connection connection / Required connection
Custom Fields code customFields		Custom fields for the technician
Daily Goal string dailyGoal		Daily revenue goal	5.6
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Email string email		Technician's email address	test@technician.us
Address code home		The home address of the technician
Job Filter string jobFilter		Upcoming appointment visibility
Job History Date Filter string jobHistoryDateFilter		Appointment history visibility
License Type string licenseType		License type
Login Username string login		Technician's username	technician_us
Memo string memo		Memo for the technician	Payment for services rendered.
Name string name		The name of the technician	Test Source
Phone Number string phoneNumber		Technician's phone number	1234567890
Positions string Value List positions		List of company positions
Role ID string roleId		User role Id	7
Team string team		Team name	Test Team
Technician ID string / Required technicianId		The ID of the technician to update	10978752986

Example Payload for Update Technician

{
  "data": {
    "id": 0
  }
}

---