ServiceTitan

App · 25 actions

Manage customers, locations and leads, and look up jobs, appointments and team settings.

Actions

ActionWhat it does
Create customerCreate customer.
Create customer contactCreate customer contact.
Create leadCreate lead.
Create locationCreate location.
Create location contactCreate location contact.
Get appointmentGet appointment.
Get customerGet customer.
Get jobGet job.
Get leadGet lead.
Get locationGet location.
List appointmentsList appointments.
List business unitsList business units.
List contactsList contacts.
List customer contactsList customer contacts.
List customersList customers.
List job typesList job types.
List jobsList jobs.
List leadsList leads.
List location contactsList location contacts.
List locationsList locations.
List tag typesList tag types.
List techniciansList technicians.
Update customerUpdate customer.
Update leadUpdate lead.
Update locationUpdate location.

Create customer

Create customer.

Inputs

NamenametextRequired
Name of the customer
Customer typecustomer_typetext
Residential or commercialOne of: Residential, Commercial.
Do not maildoNotMailtrue/false
Customer has been flagged as “do not mail”
Do not servicedoNotServicetrue/false
Customer has been flagged as “do not service”
National accountnationalAccounttrue/false
Customer has been flagged as National Account
LocationslocationslistRequired
Locations for the customer
AddressaddressobjectRequired
Bill-To address of the customer record
Contactscontactslist
Contacts for the customer
Custom fieldscustomFieldslist
Customer record’s custom fields
Tag type idstagTypeIdslist
Tag Type IDs to be associated with the customer
External dataexternalDataobject
Optional model that contains a list of external data items that should be attached to this Customer.
Tax exempttaxExempttrue/false
Optional Tax Exempt.
Payment term idpaymentTermIdnumber
Optional Payment Term ID.
Credit limitcreditLimitnumber
Credit Limit for the customer.
Credit limit balancecreditLimitBalancenumber
Credit Limit for the customer.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "active": false,
    "address": {
      "city": "example",
      "country": "example",
      "latitude": 1.0,
      "longitude": 1.0,
      "state": "example",
      "street": "example",
      "unit": "example",
      "zip": "example"
    },
    "balance": 1.0,
    "contacts": [],
    "createdById": 1,
    "createdOn": "example",
    "creditLimit": 1.0,
    "creditLimitBalance": 1.0,
    "customFields": [],
    "doNotMail": false,
    "doNotService": false,
    "externalData": [],
    "id": 1,
    "locations": [],
    "mergedToId": 1,
    "modifiedOn": "example",
    "name": "example",
    "nationalAccount": false,
    "paymentTermId": 1,
    "tagTypeIds": [],
    "taxExempt": false,
    "type": "Residential"
  }
}

Create customer contact

Create customer contact.

Inputs

IdidnumberRequired
Id.
Contact typecontact_typetextRequired
Landline, mobile, e-mail, or faxOne of: Phone, Email, Fax, MobilePhone.
ValuevaluetextRequired
The email, phone number, or fax number for the contact
Memomemotext
Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly”

Outputs

dataobject
Result.
Example output
{
  "data": {
    "createdOn": "example",
    "id": 1,
    "memo": "example",
    "modifiedOn": "example",
    "phoneSettings": {
      "doNotText": false,
      "phoneNumber": "example"
    },
    "preferences": {
      "invoiceNotification": false,
      "invoiceStatementNotification": false,
      "jobRemindersEnabled": false,
      "marketingUpdatesEnabled": false,
      "statementNotification": false
    },
    "type": "Phone",
    "value": "example"
  }
}

Create lead

Create lead.

Inputs

CustomercustomerIdnumber
ID of the customer
LocationlocationIdnumber
ID of the location
Campaign idcampaignIdnumberRequired
ID of the campaign
Business unitbusinessUnitIdnumber
ID of the business unit
Job typejobTypeIdnumber
ID of job type
SummarysummarytextRequired
Lead summary
Tag type idstagTypeIdslist
List of IDs of tags on the lead
Priorityprioritytext
Priority of the leadOne of: Low, Normal, High, Urgent.
Call reason idcallReasonIdnumber
ID of the call reason. Required if follow up date is not provided.
Follow up datefollowUpDatedate and time
Date of when to follow up. Required if call reason ID is not provided.
Booking idbookingIdnumber
The associated Booking Id to use for creating the Lead. This Booking will be dismissed and a Lead will get created associated to this Booking.
Lead customer nameleadCustomerNametext
Customer name provided for the lead
Lead phoneleadPhonetext
Phone number provided for the lead
Lead emailleadEmailtext
Email provided for the lead
Lead streetleadStreettext
Street provided for the lead
Lead unitleadUnittext
Unit provided for the lead
Lead cityleadCitytext
City provided for the lead
Lead stateleadStatetext
State provided for the lead
Lead zipleadZiptext
Zip provided for the lead
Lead countryleadCountrytext
Country provided for the lead

Outputs

dataobject
Result.
Example output
{
  "data": {
    "bookingId": 1,
    "businessUnitId": 1,
    "callId": 1,
    "callReasonId": 1,
    "campaignId": 1,
    "captureSource": "example",
    "createdById": 1,
    "createdOn": "example",
    "customerId": 1,
    "dismissingReasonId": 1,
    "followUpDate": "example",
    "id": 1,
    "jobTypeId": 1,
    "leadCity": "example",
    "leadCountry": "example",
    "leadCustomerName": "example",
    "leadEmail": "example",
    "leadPhone": "example",
    "leadState": "example",
    "leadStreet": "example",
    "leadUnit": "example",
    "leadUrl": "example",
    "leadZip": "example",
    "locationId": 1,
    "manualCallId": 1,
    "modifiedOn": "example",
    "priority": "Low",
    "status": "Open",
    "summary": "example",
    "tagTypeIds": []
  }
}

Create location

Create location.

Inputs

NamenametextRequired
Name of the location
AddressaddressobjectRequired
Address of the location record
Contactscontactslist
Contacts for the location
Custom fieldscustomFieldslist
Location record’s custom fields
Tag type idstagTypeIdslist
Tag type ids for the location
External dataexternalDataobject
Optional model that contains a list of external data items that should be attached to this Location.
Coordinates sourcecoordinatesSourcetext
Gets or sets the source of the coordinates.One of: None, System, User, Imported.
Coordinates verification statuscoordinatesVerificationStatustext
Gets or sets the verification status of the coordinates.One of: Unverified, InProgress, Failed, Verified.
Tax zone idtaxZoneIdnumber
Optional tax zone id to use for the location. When provided, this tax zone is used instead of being automatically resolved from the location’s address.
CustomercustomerIdnumberRequired
ID of the location’s customer.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "active": false,
    "address": {
      "city": "example",
      "country": "example",
      "latitude": 1.0,
      "longitude": 1.0,
      "state": "example",
      "street": "example",
      "unit": "example",
      "zip": "example"
    },
    "contacts": [],
    "createdById": 1,
    "createdOn": "example",
    "customFields": [],
    "customerId": 1,
    "externalData": [],
    "id": 1,
    "mergedToId": 1,
    "modifiedOn": "example",
    "name": "example",
    "tagTypeIds": [],
    "taxExempt": false,
    "taxZoneId": 1,
    "zoneId": 1
  }
}

Create location contact

Create location contact.

Inputs

IdidnumberRequired
Id.
Contact typecontact_typetextRequired
Type of contactOne of: Phone, Email, Fax, MobilePhone.
ValuevaluetextRequired
Value of contact
Memomemotext
Memo of contact

Outputs

dataobject
Result.
Example output
{
  "data": {
    "createdOn": "example",
    "id": 1,
    "memo": "example",
    "modifiedOn": "example",
    "phoneSettings": {
      "doNotText": false,
      "phoneNumber": "example"
    },
    "preferences": {
      "invoiceNotification": false,
      "invoiceStatementNotification": false,
      "jobRemindersEnabled": false,
      "marketingUpdatesEnabled": false,
      "statementNotification": false
    },
    "type": "Phone",
    "value": "example"
  }
}

Get appointment

Get appointment.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
Appointment response model
Example output
{
  "data": {
    "active": false,
    "appointmentNumber": "example",
    "appointmentSummaries": [],
    "arrivalWindowEnd": "example",
    "arrivalWindowStart": "example",
    "createdById": 1,
    "createdOn": "example",
    "customerId": 1,
    "end": "example",
    "id": 1,
    "isConfirmed": false,
    "jobId": 1,
    "modifiedOn": "example",
    "specialInstructions": "example",
    "start": "example",
    "status": "Scheduled",
    "unused": false
  }
}

Get customer

Get customer.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "active": false,
    "address": {
      "city": "example",
      "country": "example",
      "latitude": 1.0,
      "longitude": 1.0,
      "state": "example",
      "street": "example",
      "unit": "example",
      "zip": "example"
    },
    "balance": 1.0,
    "createdById": 1,
    "createdOn": "example",
    "creditLimit": 1.0,
    "creditLimitBalance": 1.0,
    "customFields": [],
    "doNotMail": false,
    "doNotService": false,
    "externalData": [],
    "id": 1,
    "mergedToId": 1,
    "modifiedOn": "example",
    "name": "example",
    "nationalAccount": false,
    "paymentTermId": 1,
    "tagTypeIds": [],
    "taxExempt": false,
    "type": "Residential"
  }
}

Get job

Get job.

Inputs

IdidnumberRequired
Id.
External data application guidexternalDataApplicationGuidtext
External data application guid.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "appointmentCount": 1,
    "bookingId": 1,
    "businessUnitId": 1,
    "campaignId": 1,
    "completedOn": "example",
    "createdById": 1,
    "createdFromEstimateId": 1,
    "createdOn": "example",
    "customFields": [],
    "customerId": 1,
    "customerPo": "example",
    "equipmentIds": [],
    "estimateIds": [],
    "externalData": [],
    "firstAppointmentId": 1,
    "id": 1,
    "invoiceId": 1,
    "isAutoDispatched": false,
    "jobGeneratedLeadSource": {
      "employeeId": 1,
      "jobId": 1
    },
    "jobNumber": "example",
    "jobStatus": "example",
    "jobTypeId": 1,
    "lastAppointmentId": 1,
    "leadCallId": 1,
    "locationId": 1,
    "membershipId": 1,
    "modifiedOn": "example",
    "noCharge": false,
    "notificationsEnabled": false,
    "partnerLeadCallId": 1,
    "priority": "example",
    "projectId": 1,
    "recallForId": 1,
    "soldById": 1,
    "summary": "example",
    "summaryOfWork": "example",
    "tagTypeIds": [],
    "total": 1.0,
    "warrantyId": 1
  }
}

Get lead

Get lead.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "bookingId": 1,
    "businessUnitId": 1,
    "callId": 1,
    "callReasonId": 1,
    "campaignId": 1,
    "captureSource": "example",
    "createdById": 1,
    "createdOn": "example",
    "customerId": 1,
    "dismissingReasonId": 1,
    "followUpDate": "example",
    "id": 1,
    "jobTypeId": 1,
    "leadCity": "example",
    "leadCountry": "example",
    "leadCustomerName": "example",
    "leadEmail": "example",
    "leadPhone": "example",
    "leadState": "example",
    "leadStreet": "example",
    "leadUnit": "example",
    "leadUrl": "example",
    "leadZip": "example",
    "locationId": 1,
    "manualCallId": 1,
    "modifiedOn": "example",
    "priority": "Low",
    "status": "Open",
    "summary": "example",
    "tagTypeIds": []
  }
}

Get location

Get location.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "active": false,
    "address": {
      "city": "example",
      "country": "example",
      "latitude": 1.0,
      "longitude": 1.0,
      "state": "example",
      "street": "example",
      "unit": "example",
      "zip": "example"
    },
    "createdById": 1,
    "createdOn": "example",
    "customFields": [],
    "customerId": 1,
    "externalData": [],
    "id": 1,
    "mergedToId": 1,
    "modifiedOn": "example",
    "name": "example",
    "tagTypeIds": [],
    "taxExempt": false,
    "taxZoneId": 1,
    "zoneId": 1
  }
}

List appointments

List appointments.

Inputs

Idsidstext
Ids.
Activeactivetext
Represents possible HTTP query argument values, when applying filters based on active status.One of: True, Any, False.
Job idjobIdnumber
Job id.
Project idprojectIdnumber
Project id.
Numbernumbertext
Number.
Statusstatustext
Indicates the status of a Job Appointment.One of: Scheduled, Dispatched, Working, Hold, Done, Canceled.
Starts on or afterstartsOnOrAfterdate and time
Starts on or after.
Starts beforestartsBeforedate and time
Starts before.
TechniciantechnicianIdnumber
Technician id.
CustomercustomerIdnumber
Customer id.
Unusedunusedtrue/false
Unused.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Created beforecreatedBeforedate and time
Created before.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Sortsorttext
Sort.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List business units

List business units.

Inputs

Idsidstext
Ids.
Namenametext
Name.
Activeactivetext
Represents possible HTTP query argument values, when applying filters based on active status.One of: True, Any, False.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
Sortsorttext
Sort.
External data application guidexternalDataApplicationGuidtext
External data application guid.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List contacts

List contacts.

Inputs

Namenametext
Name.
Titletitletext
Title.
Reference idreferenceIdtext
Reference id.
Is archivedisArchivedtext
Is archived.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Sortsorttext
Sort.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List customer contacts

List customer contacts.

Inputs

IdidnumberRequired
Id.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List customers

List customers.

Inputs

Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Sortsorttext
Sort.
Idsidstext
Ids.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
Exclude accounting changes from modified date rangeexcludeAccountingChangesFromModifiedDateRangetrue/false
Exclude accounting changes from modified date range.
Namenametext
Name.
Streetstreettext
Street.
Unitunittext
Unit.
Citycitytext
City.
Statestatetext
State.
Zipziptext
Zip.
Countrycountrytext
Country.
Latitudelatitudenumber
Latitude.
Longitudelongitudenumber
Longitude.
Phonephonetext
Phone.
Activeactivetext
Represents possible HTTP query argument values, when applying filters based on active status.One of: True, Any, False.
External data application guidexternalDataApplicationGuidtext
External data application guid.
External data keyexternalDataKeytext
External data key.
External data valuesexternalDataValuestext
External data values.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List job types

List job types.

Inputs

Namenametext
Name.
Min durationminDurationnumber
Min duration.
Max durationmaxDurationnumber
Max duration.
Priorityprioritytext
Priority.
Idsidstext
Ids.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Activeactivetext
Represents possible HTTP query argument values, when applying filters based on active status.One of: True, Any, False.
Order byorderBytext
Order by.
Order by directionorderByDirectiontext
Order by direction.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
External data application guidexternalDataApplicationGuidtext
External data application guid.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List jobs

List jobs.

Inputs

Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Idsidstext
Ids.
Numbernumbertext
Number.
Project idprojectIdnumber
Project id.
Booking idbookingIdnumber
Booking id.
Job statusjobStatustext
Jobstatus.One of: Scheduled, Dispatched, InProgress, Hold, Completed, Canceled.
Appointment statusappointmentStatustext
Appointmentstatus.One of: Scheduled, Dispatched, Working, Hold, Done, Canceled.
Priorityprioritytext
Priority.
First appointment starts on or afterfirstAppointmentStartsOnOrAfterdate and time
First appointment starts on or after.
First appointment starts beforefirstAppointmentStartsBeforedate and time
First appointment starts before.
Appointment starts on or afterappointmentStartsOnOrAfterdate and time
Appointment starts on or after.
Appointment starts beforeappointmentStartsBeforedate and time
Appointment starts before.
TechniciantechnicianIdnumber
Technician id.
CustomercustomerIdnumber
Customer id.
LocationlocationIdnumber
Location id.
Sold by idsoldByIdnumber
Sold by id.
Job typejobTypeIdnumber
Job type id.
Campaign idcampaignIdnumber
Campaign id.
Business unitbusinessUnitIdnumber
Business unit id.
Invoice idinvoiceIdnumber
Invoice id.
Created from estimate idcreatedFromEstimateIdnumber
Created from estimate id.
Estimate idsestimateIdstext
Estimate ids.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
Completed on or aftercompletedOnOrAfterdate and time
Completed on or after.
Completed beforecompletedBeforedate and time
Completed before.
Tag type idstagTypeIdstext
Tag type ids.
Equipment idsequipmentIdstext
Equipment ids.
Sortsorttext
Sort.
External data application guidexternalDataApplicationGuidtext
External data application guid.
External data keyexternalDataKeytext
External data key.
External data valuesexternalDataValuestext
External data values.
Has unused appointmentshasUnusedAppointmentstrue/false
Has unused appointments.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List leads

List leads.

Inputs

Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Idsidstext
Ids.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
CustomercustomerIdnumber
Customer id.
Is prospectisProspecttrue/false
Is prospect.
Without customerwithoutCustomertrue/false
Without customer.
Statusstatustext
Status.One of: Open, Dismissed, Converted.
Customer citycustomerCitytext
Customer city.
Customer statecustomerStatetext
Customer state.
Customer zipcustomerZiptext
Customer zip.
Customer created on or aftercustomerCreatedOnOrAfterdate and time
Customer created on or after.
Customer created beforecustomerCreatedBeforedate and time
Customer created before.
Customer modified on or aftercustomerModifiedOnOrAfterdate and time
Customer modified on or after.
Sortsorttext
Sort.
Gen perm urlgenPermUrltrue/false
Gen perm url.
Lead customer nameleadCustomerNametext
Lead customer name.
Lead phoneleadPhonetext
Lead phone.
Is capture source formisCaptureSourceFormtrue/false
Is capture source form.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List location contacts

List location contacts.

Inputs

IdidnumberRequired
Id.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List locations

List locations.

Inputs

Idsidstext
Ids.
Namenametext
Name.
CustomercustomerIdnumber
Customer id.
Streetstreettext
Street.
Unitunittext
Unit.
Citycitytext
City.
Statestatetext
State.
Zipziptext
Zip.
Countrycountrytext
Country.
Latitudelatitudenumber
Latitude.
Longitudelongitudenumber
Longitude.
Activeactivetext
Represents possible HTTP query argument values, when applying filters based on active status.One of: True, Any, False.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Sortsorttext
Sort.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
External data application guidexternalDataApplicationGuidtext
External data application guid.
External data keyexternalDataKeytext
External data key.
External data valuesexternalDataValuestext
External data values.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List tag types

List tag types.

Inputs

Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Activeactivetext
Represents possible HTTP query argument values, when applying filters based on active status.One of: True, Any, False.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.
Sortsorttext
Sort.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List technicians

List technicians.

Inputs

Idsidstext
Ids.
User idsuserIdstext
User ids.
Namenametext
Name.
Activeactivetext
Represents possible HTTP query argument values, when applying filters based on active status.One of: True, Any, False.
Pagepagenumber
Page.From 1 to 100000. Default: 1.
Page sizepageSizenumber
Page size.From 1 to 5000. Default: 50.
Include totalincludeTotaltrue/false
Include total.
Created beforecreatedBeforedate and time
Created before.
Created on or aftercreatedOnOrAfterdate and time
Created on or after.
Modified beforemodifiedBeforedate and time
Modified before.
Modified on or aftermodifiedOnOrAfterdate and time
Modified on or after.

Outputs

dataobject
Represents paginated API response.
Example output
{
  "data": {
    "data": [],
    "hasMore": false,
    "page": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Update customer

Update customer.

Inputs

IdidnumberRequired
Id.
Namenametext
Name of the customer
Customer typecustomer_typetext
Residential or commercialOne of: Residential, Commercial.
Addressaddressobject
Bill-To address of the customer record
Custom fieldscustomFieldslist
Customer record’s custom fields
External dataexternalDataobject
External data update model.
Do not maildoNotMailtrue/false
Customer has been flagged as “do not mail”
Do not servicedoNotServicetrue/false
Customer has been flagged as “do not service”
National accountnationalAccounttrue/false
Customer has been flagged as National Account
Activeactivetrue/false
Customer has been flagged as “active” ar "innactive"
Tag type idstagTypeIdslist
IDs of the Tag Types
Tax exempttaxExempttrue/false
Customer has been flagged as Tax Exempt
Payment term idpaymentTermIdnumber
Payment Term ID
Credit limitcreditLimitnumber
Credit Limit for the customer.
Credit limit balancecreditLimitBalancenumber
Credit Limit Balance for the customer.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "active": false,
    "address": {
      "city": "example",
      "country": "example",
      "latitude": 1.0,
      "longitude": 1.0,
      "state": "example",
      "street": "example",
      "unit": "example",
      "zip": "example"
    },
    "balance": 1.0,
    "createdById": 1,
    "createdOn": "example",
    "creditLimit": 1.0,
    "creditLimitBalance": 1.0,
    "customFields": [],
    "doNotMail": false,
    "doNotService": false,
    "externalData": [],
    "id": 1,
    "mergedToId": 1,
    "modifiedOn": "example",
    "name": "example",
    "nationalAccount": false,
    "paymentTermId": 1,
    "tagTypeIds": [],
    "taxExempt": false,
    "type": "Residential"
  }
}

Update lead

Update lead.

Inputs

IdidnumberRequired
Id.
Campaign idcampaignIdnumber
ID of the campaign
Priorityprioritytext
Priority of the leadOne of: Low, Normal, High, Urgent.
Business unitbusinessUnitIdnumber
ID of the business unit
Job typejobTypeIdnumber
ID of job type
Summarysummarytext
Lead summary
Lead customer nameleadCustomerNametext
Customer name provided for the lead
Lead phoneleadPhonetext
Phone number provided for the lead
Lead emailleadEmailtext
Email provided for the lead
Lead streetleadStreettext
Street provided for the lead
Lead unitleadUnittext
Unit provided for the lead
Lead cityleadCitytext
City provided for the lead
Lead stateleadStatetext
State provided for the lead
Lead zipleadZiptext
Zip provided for the lead
Lead countryleadCountrytext
Country provided for the lead

Outputs

dataobject
Result.
Example output
{
  "data": {
    "bookingId": 1,
    "businessUnitId": 1,
    "callId": 1,
    "callReasonId": 1,
    "campaignId": 1,
    "captureSource": "example",
    "createdById": 1,
    "createdOn": "example",
    "customerId": 1,
    "dismissingReasonId": 1,
    "followUpDate": "example",
    "id": 1,
    "jobTypeId": 1,
    "leadCity": "example",
    "leadCountry": "example",
    "leadCustomerName": "example",
    "leadEmail": "example",
    "leadPhone": "example",
    "leadState": "example",
    "leadStreet": "example",
    "leadUnit": "example",
    "leadUrl": "example",
    "leadZip": "example",
    "locationId": 1,
    "manualCallId": 1,
    "modifiedOn": "example",
    "priority": "Low",
    "status": "Open",
    "summary": "example",
    "tagTypeIds": []
  }
}

Update location

Update location.

Inputs

IdidnumberRequired
Id.
CustomercustomerIdnumber
ID of the location’s customer.
Namenametext
Name of the location
Addressaddressobject
Address of the location record
Activeactivetrue/false
If false, the record has been deactivated.
Tax zone idtaxZoneIdnumber
ID of the location tax zone
Custom fieldscustomFieldslist
List of custom fields and their values. This list must describe the full list of custom fields on the location. If location A has values for custom fields X and Y and this field only contains a model for custom field X, then the value for custom field Y on location A will be removed.
Tag type idstagTypeIdslist
List of tag type IDs. If location has tag types X and Y and this field only contains tag type X, then Y will removed from the location. If it is an empty list, all tags on the location will be removed.
External dataexternalDataobject
Optional model that contains a list of external data items that should be updated to this Location.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "active": false,
    "address": {
      "city": "example",
      "country": "example",
      "latitude": 1.0,
      "longitude": 1.0,
      "state": "example",
      "street": "example",
      "unit": "example",
      "zip": "example"
    },
    "createdById": 1,
    "createdOn": "example",
    "customFields": [],
    "customerId": 1,
    "externalData": [],
    "id": 1,
    "mergedToId": 1,
    "modifiedOn": "example",
    "name": "example",
    "tagTypeIds": [],
    "taxExempt": false,
    "taxZoneId": 1,
    "zoneId": 1
  }
}

On this page