ServiceTitan
App · 25 actions
Manage customers, locations and leads, and look up jobs, appointments and team settings.
Actions
| Action | What it does |
|---|---|
| Create customer | Create customer. |
| Create customer contact | Create customer contact. |
| Create lead | Create lead. |
| Create location | Create location. |
| Create location contact | Create location contact. |
| Get appointment | Get appointment. |
| Get customer | Get customer. |
| Get job | Get job. |
| Get lead | Get lead. |
| Get location | Get location. |
| List appointments | List appointments. |
| List business units | List business units. |
| List contacts | List contacts. |
| List customer contacts | List customer contacts. |
| List customers | List customers. |
| List job types | List job types. |
| List jobs | List jobs. |
| List leads | List leads. |
| List location contacts | List location contacts. |
| List locations | List locations. |
| List tag types | List tag types. |
| List technicians | List technicians. |
| Update customer | Update customer. |
| Update lead | Update lead. |
| Update location | Update location. |
Create customer
Create customer.
Inputs
- Name
nametextRequired - Name of the customer
- Customer type
customer_typetext - Residential or commercialOne of:
Residential,Commercial. - Do not mail
doNotMailtrue/false - Customer has been flagged as “do not mail”
- Do not service
doNotServicetrue/false - Customer has been flagged as “do not service”
- National account
nationalAccounttrue/false - Customer has been flagged as National Account
- Locations
locationslistRequired - Locations for the customer
- Address
addressobjectRequired - Bill-To address of the customer record
- Contacts
contactslist - Contacts for the customer
- Custom fields
customFieldslist - Customer record’s custom fields
- Tag type ids
tagTypeIdslist - Tag Type IDs to be associated with the customer
- External data
externalDataobject - Optional model that contains a list of external data items that should be attached to this Customer.
- Tax exempt
taxExempttrue/false - Optional Tax Exempt.
- Payment term id
paymentTermIdnumber - Optional Payment Term ID.
- Credit limit
creditLimitnumber - Credit Limit for the customer.
- Credit limit balance
creditLimitBalancenumber - 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
- Id
idnumberRequired - Id.
- Contact type
contact_typetextRequired - Landline, mobile, e-mail, or faxOne of:
Phone,Email,Fax,MobilePhone. - Value
valuetextRequired - The email, phone number, or fax number for the contact
- Memo
memotext - 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
- Customer
customerIdnumber - ID of the customer
- Location
locationIdnumber - ID of the location
- Campaign id
campaignIdnumberRequired - ID of the campaign
- Business unit
businessUnitIdnumber - ID of the business unit
- Job type
jobTypeIdnumber - ID of job type
- Summary
summarytextRequired - Lead summary
- Tag type ids
tagTypeIdslist - List of IDs of tags on the lead
- Priority
prioritytext - Priority of the leadOne of:
Low,Normal,High,Urgent. - Call reason id
callReasonIdnumber - ID of the call reason. Required if follow up date is not provided.
- Follow up date
followUpDatedate and time - Date of when to follow up. Required if call reason ID is not provided.
- Booking id
bookingIdnumber - 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 name
leadCustomerNametext - Customer name provided for the lead
- Lead phone
leadPhonetext - Phone number provided for the lead
- Lead email
leadEmailtext - Email provided for the lead
- Lead street
leadStreettext - Street provided for the lead
- Lead unit
leadUnittext - Unit provided for the lead
- Lead city
leadCitytext - City provided for the lead
- Lead state
leadStatetext - State provided for the lead
- Lead zip
leadZiptext - Zip provided for the lead
- Lead country
leadCountrytext - 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
- Name
nametextRequired - Name of the location
- Address
addressobjectRequired - Address of the location record
- Contacts
contactslist - Contacts for the location
- Custom fields
customFieldslist - Location record’s custom fields
- Tag type ids
tagTypeIdslist - Tag type ids for the location
- External data
externalDataobject - Optional model that contains a list of external data items that should be attached to this Location.
- Coordinates source
coordinatesSourcetext - Gets or sets the source of the coordinates.One of:
None,System,User,Imported. - Coordinates verification status
coordinatesVerificationStatustext - Gets or sets the verification status of the coordinates.One of:
Unverified,InProgress,Failed,Verified. - Tax zone id
taxZoneIdnumber - 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.
- Customer
customerIdnumberRequired - 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
- Id
idnumberRequired - Id.
- Contact type
contact_typetextRequired - Type of contactOne of:
Phone,Email,Fax,MobilePhone. - Value
valuetextRequired - Value of contact
- Memo
memotext - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - Id.
- External data application guid
externalDataApplicationGuidtext - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Ids
idstext - Ids.
- Active
activetext - Represents possible HTTP query argument values, when applying filters based on active status.One of:
True,Any,False. - Job id
jobIdnumber - Job id.
- Project id
projectIdnumber - Project id.
- Number
numbertext - Number.
- Status
statustext - Indicates the status of a Job Appointment.One of:
Scheduled,Dispatched,Working,Hold,Done,Canceled. - Starts on or after
startsOnOrAfterdate and time - Starts on or after.
- Starts before
startsBeforedate and time - Starts before.
- Technician
technicianIdnumber - Technician id.
- Customer
customerIdnumber - Customer id.
- Unused
unusedtrue/false - Unused.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Created before
createdBeforedate and time - Created before.
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Sort
sorttext - 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
- Ids
idstext - Ids.
- Name
nametext - Name.
- Active
activetext - Represents possible HTTP query argument values, when applying filters based on active status.One of:
True,Any,False. - Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- Sort
sorttext - Sort.
- External data application guid
externalDataApplicationGuidtext - 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
- Name
nametext - Name.
- Title
titletext - Title.
- Reference id
referenceIdtext - Reference id.
- Is archived
isArchivedtext - Is archived.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Sort
sorttext - 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
- Id
idnumberRequired - Id.
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/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
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Sort
sorttext - Sort.
- Ids
idstext - Ids.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- Exclude accounting changes from modified date range
excludeAccountingChangesFromModifiedDateRangetrue/false - Exclude accounting changes from modified date range.
- Name
nametext - Name.
- Street
streettext - Street.
- Unit
unittext - Unit.
- City
citytext - City.
- State
statetext - State.
- Zip
ziptext - Zip.
- Country
countrytext - Country.
- Latitude
latitudenumber - Latitude.
- Longitude
longitudenumber - Longitude.
- Phone
phonetext - Phone.
- Active
activetext - Represents possible HTTP query argument values, when applying filters based on active status.One of:
True,Any,False. - External data application guid
externalDataApplicationGuidtext - External data application guid.
- External data key
externalDataKeytext - External data key.
- External data values
externalDataValuestext - 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
- Name
nametext - Name.
- Min duration
minDurationnumber - Min duration.
- Max duration
maxDurationnumber - Max duration.
- Priority
prioritytext - Priority.
- Ids
idstext - Ids.
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Active
activetext - Represents possible HTTP query argument values, when applying filters based on active status.One of:
True,Any,False. - Order by
orderBytext - Order by.
- Order by direction
orderByDirectiontext - Order by direction.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- External data application guid
externalDataApplicationGuidtext - 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
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Ids
idstext - Ids.
- Number
numbertext - Number.
- Project id
projectIdnumber - Project id.
- Booking id
bookingIdnumber - Booking id.
- Job status
jobStatustext - Jobstatus.One of:
Scheduled,Dispatched,InProgress,Hold,Completed,Canceled. - Appointment status
appointmentStatustext - Appointmentstatus.One of:
Scheduled,Dispatched,Working,Hold,Done,Canceled. - Priority
prioritytext - Priority.
- First appointment starts on or after
firstAppointmentStartsOnOrAfterdate and time - First appointment starts on or after.
- First appointment starts before
firstAppointmentStartsBeforedate and time - First appointment starts before.
- Appointment starts on or after
appointmentStartsOnOrAfterdate and time - Appointment starts on or after.
- Appointment starts before
appointmentStartsBeforedate and time - Appointment starts before.
- Technician
technicianIdnumber - Technician id.
- Customer
customerIdnumber - Customer id.
- Location
locationIdnumber - Location id.
- Sold by id
soldByIdnumber - Sold by id.
- Job type
jobTypeIdnumber - Job type id.
- Campaign id
campaignIdnumber - Campaign id.
- Business unit
businessUnitIdnumber - Business unit id.
- Invoice id
invoiceIdnumber - Invoice id.
- Created from estimate id
createdFromEstimateIdnumber - Created from estimate id.
- Estimate ids
estimateIdstext - Estimate ids.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- Completed on or after
completedOnOrAfterdate and time - Completed on or after.
- Completed before
completedBeforedate and time - Completed before.
- Tag type ids
tagTypeIdstext - Tag type ids.
- Equipment ids
equipmentIdstext - Equipment ids.
- Sort
sorttext - Sort.
- External data application guid
externalDataApplicationGuidtext - External data application guid.
- External data key
externalDataKeytext - External data key.
- External data values
externalDataValuestext - External data values.
- Has unused appointments
hasUnusedAppointmentstrue/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
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Ids
idstext - Ids.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- Customer
customerIdnumber - Customer id.
- Is prospect
isProspecttrue/false - Is prospect.
- Without customer
withoutCustomertrue/false - Without customer.
- Status
statustext - Status.One of:
Open,Dismissed,Converted. - Customer city
customerCitytext - Customer city.
- Customer state
customerStatetext - Customer state.
- Customer zip
customerZiptext - Customer zip.
- Customer created on or after
customerCreatedOnOrAfterdate and time - Customer created on or after.
- Customer created before
customerCreatedBeforedate and time - Customer created before.
- Customer modified on or after
customerModifiedOnOrAfterdate and time - Customer modified on or after.
- Sort
sorttext - Sort.
- Gen perm url
genPermUrltrue/false - Gen perm url.
- Lead customer name
leadCustomerNametext - Lead customer name.
- Lead phone
leadPhonetext - Lead phone.
- Is capture source form
isCaptureSourceFormtrue/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
- Id
idnumberRequired - Id.
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/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
- Ids
idstext - Ids.
- Name
nametext - Name.
- Customer
customerIdnumber - Customer id.
- Street
streettext - Street.
- Unit
unittext - Unit.
- City
citytext - City.
- State
statetext - State.
- Zip
ziptext - Zip.
- Country
countrytext - Country.
- Latitude
latitudenumber - Latitude.
- Longitude
longitudenumber - Longitude.
- Active
activetext - Represents possible HTTP query argument values, when applying filters based on active status.One of:
True,Any,False. - Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Sort
sorttext - Sort.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- External data application guid
externalDataApplicationGuidtext - External data application guid.
- External data key
externalDataKeytext - External data key.
- External data values
externalDataValuestext - 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
- Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Active
activetext - Represents possible HTTP query argument values, when applying filters based on active status.One of:
True,Any,False. - Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate and time - Modified on or after.
- Sort
sorttext - Sort.
Outputs
dataobject- Represents paginated API response.
Example output
{
"data": {
"data": [],
"hasMore": false,
"page": 1,
"pageSize": 1,
"totalCount": 1
}
}List technicians
List technicians.
Inputs
- Ids
idstext - Ids.
- User ids
userIdstext - User ids.
- Name
nametext - Name.
- Active
activetext - Represents possible HTTP query argument values, when applying filters based on active status.One of:
True,Any,False. - Page
pagenumber - Page.From 1 to 100000. Default:
1. - Page size
pageSizenumber - Page size.From 1 to 5000. Default:
50. - Include total
includeTotaltrue/false - Include total.
- Created before
createdBeforedate and time - Created before.
- Created on or after
createdOnOrAfterdate and time - Created on or after.
- Modified before
modifiedBeforedate and time - Modified before.
- Modified on or after
modifiedOnOrAfterdate 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
- Id
idnumberRequired - Id.
- Name
nametext - Name of the customer
- Customer type
customer_typetext - Residential or commercialOne of:
Residential,Commercial. - Address
addressobject - Bill-To address of the customer record
- Custom fields
customFieldslist - Customer record’s custom fields
- External data
externalDataobject - External data update model.
- Do not mail
doNotMailtrue/false - Customer has been flagged as “do not mail”
- Do not service
doNotServicetrue/false - Customer has been flagged as “do not service”
- National account
nationalAccounttrue/false - Customer has been flagged as National Account
- Active
activetrue/false - Customer has been flagged as “active” ar "innactive"
- Tag type ids
tagTypeIdslist - IDs of the Tag Types
- Tax exempt
taxExempttrue/false - Customer has been flagged as Tax Exempt
- Payment term id
paymentTermIdnumber - Payment Term ID
- Credit limit
creditLimitnumber - Credit Limit for the customer.
- Credit limit balance
creditLimitBalancenumber - 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
- Id
idnumberRequired - Id.
- Campaign id
campaignIdnumber - ID of the campaign
- Priority
prioritytext - Priority of the leadOne of:
Low,Normal,High,Urgent. - Business unit
businessUnitIdnumber - ID of the business unit
- Job type
jobTypeIdnumber - ID of job type
- Summary
summarytext - Lead summary
- Lead customer name
leadCustomerNametext - Customer name provided for the lead
- Lead phone
leadPhonetext - Phone number provided for the lead
- Lead email
leadEmailtext - Email provided for the lead
- Lead street
leadStreettext - Street provided for the lead
- Lead unit
leadUnittext - Unit provided for the lead
- Lead city
leadCitytext - City provided for the lead
- Lead state
leadStatetext - State provided for the lead
- Lead zip
leadZiptext - Zip provided for the lead
- Lead country
leadCountrytext - 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
- Id
idnumberRequired - Id.
- Customer
customerIdnumber - ID of the location’s customer.
- Name
nametext - Name of the location
- Address
addressobject - Address of the location record
- Active
activetrue/false - If false, the record has been deactivated.
- Tax zone id
taxZoneIdnumber - ID of the location tax zone
- Custom fields
customFieldslist - 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 ids
tagTypeIdslist - 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 data
externalDataobject - 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
}
}