ServiceWorks

App · 23 actions

Run your field service business in ServiceWorks: find and add customers, book and schedule jobs, assign technicians, update job status, text customers, email invoices, and list invoices and payments.

Actions

ActionWhat it does
Add customer noteAdd a line to the note on a customer's record, or replace the note.
Add job noteAdd a note to a job, for the office and its technicians.
Create customerAdd a customer with their phone, email and service address, such as from a website booking form.
Create jobBook a new job (work order) for a customer on a day, with its technicians if you like.
Email job invoiceEmail a job's invoice (or estimate) from ServiceWorks, with a message of your own.
Find customersFind customers by name, phone, email, account number or address.
Find jobsFind jobs booked in a date range (today unless given), or every job for a customer or job number.
Find partsFind parts in your item catalog by part number or description.
Get customerGet one customer with their addresses, balances due, red flag and custom fields.
Get dashboard figuresGet the figures on ServiceWorks' dashboard for a date range (today unless given), for a daily report.
Get jobGet one job by its id or job number, with each visit to it.
Get service historyList the service a customer has had, up to a day.
Get text messagesGet the text conversation with a customer.
List invoicesList unpaid, paid or canceled invoices from a date range (the last 30 days unless given).
List paymentsList the payments you have received, a page at a time.
List scheduleList the jobs on the calendar for up to 31 days (today unless given), for one technician, job type or status if you like.
List techniciansList your technicians, or those whose name has some text.
Schedule jobBook a job's visit for a day and time, and assign its technicians.
Send text to customerText a customer from your ServiceWorks number, at their main phone unless you give another.
Set work performedWrite what was done on a job's visit, the explanation of service shown on its invoice.
Update customerChange a customer's name, company, account number, phones, email or update preferences.
Update customer addressChange one of a customer's addresses.
Update job statusSet a job's status, such as completed or canceled.

Add customer note

Add a line to the note on a customer's record, or replace the note.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.
NotenotetextRequired
The text to add.
Howmodetext
Add to the end of the note, or replace it.One of: append (Add to the end of the note), replace (Replace the note). Default: append.

Outputs

customerobject
The customer, as ServiceWorks returns it
customer_idnumber
The customer's id
Example output
{
  "customer": {
    "AccountNumber": "TEST1",
    "Addresses": [
      {
        "AddressId": 15695363,
        "AddressLine1": "1001 Craig Road",
        "AddressLine2": "",
        "City": "ST. LOUIS",
        "CountryCode": "",
        "Email": "jerry.holland@none.com",
        "FirstName": "Starter",
        "IsActive": true,
        "IsParentAddress": false,
        "LastName": "Package",
        "Lat": "38.6725623",
        "Long": "-90.4370574",
        "Note": "",
        "NotifyEmail": false,
        "NotifyPrimaryPhone": false,
        "NotifySecondaryPhone": false,
        "PrimaryPhone": "636 220 4363",
        "SecondaryPhone": "",
        "State": "MO",
        "Type": 2,
        "Zip": "63146"
      }
    ],
    "BillToId": 0,
    "CompanyName": "Jerry Holland Test",
    "Content": [],
    "CustomFields": [
      {
        "FieldId": 1,
        "FieldName": "Industry",
        "FieldType": "Text",
        "FieldTypeId": 1,
        "FieldValue": "Service",
        "Fields": [],
        "MandetoryforInstantBooking": false,
        "MappingId": 142472,
        "SelectedValue": 0
      }
    ],
    "CustomerId": 14563590,
    "CustomerType": 0,
    "Email": "",
    "Finance": {
      "CreditLimit": 0,
      "CurrentDue": 0,
      "IsTaxExempt": false,
      "TaxCode": null
    },
    "FirstName": "Jerry",
    "IsActive": true,
    "ItemPrice": null,
    "LastName": "Holland",
    "LeadStatus": "Test 1",
    "LeadStatusId": 3521,
    "Note": "",
    "ParentId": 0,
    "ParentName": null,
    "PickupPointId": null,
    "PrimaryPhone": "1112223333",
    "PropertyManagementCustomerAccNumber": "",
    "PropertyManagementCustomerId": 0,
    "RedFlag": {
      "CreatedBy": null,
      "CreatedByUserId": 0,
      "IsRedFlagActivated": false,
      "Reason": null,
      "TimeStamp": "0001-01-01T00:00:00"
    },
    "SalesMan": "",
    "SecondaryPhone": null,
    "SendEmial": true,
    "SendTextToPrimaryPhone": true,
    "SendTextToSecondaryPhone": false,
    "Status": 1,
    "Technician": ""
  },
  "customer_id": 14563590
}

Add job note

Add a note to a job, for the office and its technicians.

Inputs

Job IDjob_idtextRequired
The job's id, from 'Create job', 'Find jobs' or an earlier step.
NotenotetextRequired
The note's text.
Visit IDvisit_idtext
Which visit to the job, for a job with more than one. Leave empty for its latest visit.

Outputs

job_idnumber
The job's id
messagetext
ServiceWorks' own confirmation message
visit_idnumber
The visit's id
Example output
{
  "job_id": 716519,
  "message": "Success",
  "visit_id": 723845
}

Create customer

Add a customer with their phone, email and service address, such as from a website booking form.

Inputs

First namefirst_nametextRequired
The customer's first name.
Last namelast_nametext
The customer's last name.
Companycompany_nametext
The customer's company, for a business customer.
PhonephonetextRequired
The customer's main phone number, such as 636 220 4363.
Second phonesecond_phonetext
Another phone number for the customer.
Emailemailtext
The customer's email address.
Street addressaddress_line1textRequired
Where the service takes place, such as 9 Pebble Creek Road.
CitycitytextRequired
The service address's city.
StatestatetextRequired
The service address's state, such as MO.
ZIP codezip_codetext
The service address's ZIP or postal code.
Email updatesemail_updatestrue/false
Email the customer about their jobs. On unless turned off.Default: true.
Text updatestext_updatestrue/false
Text the customer about their jobs. Off unless turned on.Default: false.

Outputs

customerobject
The customer, as ServiceWorks returns it
customer_idnumber
The customer's id
Example output
{
  "customer": {
    "AccountNumber": "TEST1",
    "Addresses": [
      {
        "AddressId": 15695363,
        "AddressLine1": "1001 Craig Road",
        "AddressLine2": "",
        "City": "ST. LOUIS",
        "CountryCode": "",
        "Email": "jerry.holland@none.com",
        "FirstName": "Starter",
        "IsActive": true,
        "IsParentAddress": false,
        "LastName": "Package",
        "Lat": "38.6725623",
        "Long": "-90.4370574",
        "Note": "",
        "NotifyEmail": false,
        "NotifyPrimaryPhone": false,
        "NotifySecondaryPhone": false,
        "PrimaryPhone": "636 220 4363",
        "SecondaryPhone": "",
        "State": "MO",
        "Type": 2,
        "Zip": "63146"
      }
    ],
    "BillToId": 0,
    "CompanyName": "Jerry Holland Test",
    "Content": [],
    "CustomFields": [
      {
        "FieldId": 1,
        "FieldName": "Industry",
        "FieldType": "Text",
        "FieldTypeId": 1,
        "FieldValue": "Service",
        "Fields": [],
        "MandetoryforInstantBooking": false,
        "MappingId": 142472,
        "SelectedValue": 0
      }
    ],
    "CustomerId": 14563590,
    "CustomerType": 0,
    "Email": "",
    "Finance": {
      "CreditLimit": 0,
      "CurrentDue": 0,
      "IsTaxExempt": false,
      "TaxCode": null
    },
    "FirstName": "Jerry",
    "IsActive": true,
    "ItemPrice": null,
    "LastName": "Holland",
    "LeadStatus": "Test 1",
    "LeadStatusId": 3521,
    "Note": "",
    "ParentId": 0,
    "ParentName": null,
    "PickupPointId": null,
    "PrimaryPhone": "1112223333",
    "PropertyManagementCustomerAccNumber": "",
    "PropertyManagementCustomerId": 0,
    "RedFlag": {
      "CreatedBy": null,
      "CreatedByUserId": 0,
      "IsRedFlagActivated": false,
      "Reason": null,
      "TimeStamp": "0001-01-01T00:00:00"
    },
    "SalesMan": "",
    "SecondaryPhone": null,
    "SendEmial": true,
    "SendTextToPrimaryPhone": true,
    "SendTextToSecondaryPhone": false,
    "Status": 1,
    "Technician": ""
  },
  "customer_id": 14563590
}

Create job

Book a new job (work order) for a customer on a day, with its technicians if you like.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.
ProblemdescriptiontextRequired
What the customer needs, such as 'Dryer not heating'.
Datevisit_datedateRequired
The day of the visit.
Timestart_timetime
The time the visit starts, in your business's own time.
Length in minutesduration_minutesnumber
How long the visit takes. Defaults to 60.From 5 to 1440.
Arrival windowtime_window_idtext
One of your arrival windows (such as 8 to 12). Leave empty to book for the day.
Job typejob_type_idtext
The kind of job, from your ServiceWorks job types.
Technicianstechnician_idslist
The technicians to assign. The first one picked leads the visit.
Service address IDaddress_idtext
Which of the customer's addresses (AddressId) the visit is at. Leave empty for ServiceWorks' default.
Job notejob_notetext
A note for the office and technicians.

Outputs

jobobject
The new job
Example output
{
  "job": {
    "customer_id": 14563590,
    "details": {
      "CustomerId": 14563590,
      "TicketId": 716519,
      "TicketNumber": "58037",
      "TicketStatus": "Scheduled",
      "TicketStatusId": 2,
      "TripAssignmentId": 723845
    },
    "job_id": 716519,
    "job_number": "58037",
    "status": "Scheduled",
    "status_id": 2,
    "visit_id": 723845
  }
}

Email job invoice

Email a job's invoice (or estimate) from ServiceWorks, with a message of your own.

Inputs

Job IDjob_idtextRequired
The job's id, from 'Create job', 'Find jobs' or an earlier step.
TototextRequired
Email addresses to send to, separated by commas.
SubjectsubjecttextRequired
The email's subject.
Messagemessagetext
The email's text.
Cccctext
Email addresses to copy in, separated by commas.
Bccbcctext
Email addresses to copy in privately, separated by commas.
Attach invoiceattach_invoicetrue/false
Attach the job's invoice. On unless turned off.Default: true.
Attach estimateattach_estimatetrue/false
Attach the job's estimate.Default: false.
Visit IDvisit_idtext
Which visit to the job, for a job with more than one. Leave empty for its latest visit.

Outputs

job_idnumber
The job's id
messagetext
ServiceWorks' own confirmation message
totext
Who it was sent to
visit_idnumber
The visit's id
Example output
{
  "job_id": 716519,
  "message": "Success",
  "to": "james@example.com",
  "visit_id": 723845
}

Find customers

Find customers by name, phone, email, account number or address. Give at least one.

Inputs

Namenametext
All or part of the customer's name.
Phonephonetext
The customer's phone number.
Emailemailtext
The customer's email address.
Account numberaccount_numbertext
The customer's account number.
Addressaddresstext
All or part of the customer's address.
Red-flagged onlyflagged_onlytrue/false
Only customers who are red-flagged.Default: false.

Outputs

countnumber
How many were returned
customerslist
The matching customers
Example output
{
  "count": 1,
  "customers": [
    {
      "AccountNumber": "TEST1",
      "Addresses": [
        {
          "AddressId": 15695363,
          "AddressLine1": "1001 Craig Road",
          "AddressLine2": "",
          "City": "ST. LOUIS",
          "CountryCode": "",
          "Email": "jerry.holland@none.com",
          "FirstName": "Starter",
          "IsActive": true,
          "IsParentAddress": false,
          "LastName": "Package",
          "Lat": "38.6725623",
          "Long": "-90.4370574",
          "Note": "",
          "NotifyEmail": false,
          "NotifyPrimaryPhone": false,
          "NotifySecondaryPhone": false,
          "PrimaryPhone": "636 220 4363",
          "SecondaryPhone": "",
          "State": "MO",
          "Type": 2,
          "Zip": "63146"
        }
      ],
      "BillToId": 0,
      "CompanyName": "Jerry Holland Test",
      "Content": [],
      "CustomFields": [
        {
          "FieldId": 1,
          "FieldName": "Industry",
          "FieldType": "Text",
          "FieldTypeId": 1,
          "FieldValue": "Service",
          "Fields": [],
          "MandetoryforInstantBooking": false,
          "MappingId": 142472,
          "SelectedValue": 0
        }
      ],
      "CustomerId": 14563590,
      "CustomerType": 0,
      "Email": "",
      "Finance": {
        "CreditLimit": 0,
        "CurrentDue": 0,
        "IsTaxExempt": false,
        "TaxCode": null
      },
      "FirstName": "Jerry",
      "IsActive": true,
      "ItemPrice": null,
      "LastName": "Holland",
      "LeadStatus": "Test 1",
      "LeadStatusId": 3521,
      "Note": "",
      "ParentId": 0,
      "ParentName": null,
      "PickupPointId": null,
      "PrimaryPhone": "1112223333",
      "PropertyManagementCustomerAccNumber": "",
      "PropertyManagementCustomerId": 0,
      "RedFlag": {
        "CreatedBy": null,
        "CreatedByUserId": 0,
        "IsRedFlagActivated": false,
        "Reason": null,
        "TimeStamp": "0001-01-01T00:00:00"
      },
      "SalesMan": "",
      "SecondaryPhone": null,
      "SendEmial": true,
      "SendTextToPrimaryPhone": true,
      "SendTextToSecondaryPhone": false,
      "Status": 1,
      "Technician": ""
    }
  ]
}

Find jobs

Find jobs booked in a date range (today unless given), or every job for a customer or job number.

Inputs

Fromfrom_datedate
The first day to include. Defaults to the 'To' day, or today.
Toto_datedate
The last day to include. Defaults to today.
Customer IDcustomer_idtext
Only this customer's jobs.
Customer namecustomer_nametext
Only jobs for customers with this name.
Job numberjob_numbertext
Only the job with this number.
Unassigned onlyunassigned_onlytrue/false
Only jobs with no technician yet.Default: false.

Outputs

countnumber
How many were returned
jobslist
The jobs, one row per visit
Example output
{
  "count": 1,
  "jobs": [
    {
      "customer_id": 14563590,
      "details": {
        "CustomerId": 14563590,
        "TicketId": 716519,
        "TicketNumber": "58037",
        "TicketStatus": "Scheduled",
        "TicketStatusId": 2,
        "TripAssignmentId": 723845
      },
      "job_id": 716519,
      "job_number": "58037",
      "status": "Scheduled",
      "status_id": 2,
      "visit_id": 723845
    }
  ]
}

Find parts

Find parts in your item catalog by part number or description.

Inputs

SearchsearchtextRequired
All or part of a part number or description.

Outputs

countnumber
How many were returned
partslist
The matching parts, as ServiceWorks lists them
Example output
{
  "count": 1,
  "parts": [
    {
      "PartDescription": "DRIER",
      "PartNumber": "WPW10143759"
    }
  ]
}

Get customer

Get one customer with their addresses, balances due, red flag and custom fields.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.

Outputs

customerobject
The customer, as ServiceWorks returns it
customer_idnumber
The customer's id
Example output
{
  "customer": {
    "AccountNumber": "TEST1",
    "Addresses": [
      {
        "AddressId": 15695363,
        "AddressLine1": "1001 Craig Road",
        "AddressLine2": "",
        "City": "ST. LOUIS",
        "CountryCode": "",
        "Email": "jerry.holland@none.com",
        "FirstName": "Starter",
        "IsActive": true,
        "IsParentAddress": false,
        "LastName": "Package",
        "Lat": "38.6725623",
        "Long": "-90.4370574",
        "Note": "",
        "NotifyEmail": false,
        "NotifyPrimaryPhone": false,
        "NotifySecondaryPhone": false,
        "PrimaryPhone": "636 220 4363",
        "SecondaryPhone": "",
        "State": "MO",
        "Type": 2,
        "Zip": "63146"
      }
    ],
    "BillToId": 0,
    "CompanyName": "Jerry Holland Test",
    "Content": [],
    "CustomFields": [
      {
        "FieldId": 1,
        "FieldName": "Industry",
        "FieldType": "Text",
        "FieldTypeId": 1,
        "FieldValue": "Service",
        "Fields": [],
        "MandetoryforInstantBooking": false,
        "MappingId": 142472,
        "SelectedValue": 0
      }
    ],
    "CustomerId": 14563590,
    "CustomerType": 0,
    "Email": "",
    "Finance": {
      "CreditLimit": 0,
      "CurrentDue": 0,
      "IsTaxExempt": false,
      "TaxCode": null
    },
    "FirstName": "Jerry",
    "IsActive": true,
    "ItemPrice": null,
    "LastName": "Holland",
    "LeadStatus": "Test 1",
    "LeadStatusId": 3521,
    "Note": "",
    "ParentId": 0,
    "ParentName": null,
    "PickupPointId": null,
    "PrimaryPhone": "1112223333",
    "PropertyManagementCustomerAccNumber": "",
    "PropertyManagementCustomerId": 0,
    "RedFlag": {
      "CreatedBy": null,
      "CreatedByUserId": 0,
      "IsRedFlagActivated": false,
      "Reason": null,
      "TimeStamp": "0001-01-01T00:00:00"
    },
    "SalesMan": "",
    "SecondaryPhone": null,
    "SendEmial": true,
    "SendTextToPrimaryPhone": true,
    "SendTextToSecondaryPhone": false,
    "Status": 1,
    "Technician": ""
  },
  "customer_id": 14563590
}

Get dashboard figures

Get the figures on ServiceWorks' dashboard for a date range (today unless given), for a daily report.

Inputs

Fromfrom_datedate
The first day to include. Defaults to the 'To' day, or today.
Toto_datedate
The last day to include. Defaults to today.

Outputs

dashboardobject
The figures, as ServiceWorks names them
from_datetext
The first day, YYYY-MM-DD
to_datetext
The last day, YYYY-MM-DD
Example output
{
  "dashboard": {
    "TotalJobs": 12
  },
  "from_date": "2026-10-21",
  "to_date": "2026-10-21"
}

Get job

Get one job by its id or job number, with each visit to it. Give one of the two.

Inputs

Job IDjob_idtext
The job's id, from 'Create job' or 'Find jobs'.
Job numberjob_numbertext
The job number shown in ServiceWorks.

Outputs

countnumber
How many visits
jobobject
The job's latest visit
visitslist
Every visit to the job
Example output
{
  "count": 1,
  "job": {
    "customer_id": 14563590,
    "details": {
      "CustomerId": 14563590,
      "TicketId": 716519,
      "TicketNumber": "58037",
      "TicketStatus": "Scheduled",
      "TicketStatusId": 2,
      "TripAssignmentId": 723845
    },
    "job_id": 716519,
    "job_number": "58037",
    "status": "Scheduled",
    "status_id": 2,
    "visit_id": 723845
  },
  "visits": [
    {
      "customer_id": 14563590,
      "details": {
        "CustomerId": 14563590,
        "TicketId": 716519,
        "TicketNumber": "58037",
        "TicketStatus": "Scheduled",
        "TicketStatusId": 2,
        "TripAssignmentId": 723845
      },
      "job_id": 716519,
      "job_number": "58037",
      "status": "Scheduled",
      "status_id": 2,
      "visit_id": 723845
    }
  ]
}

Get service history

List the service a customer has had, up to a day.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.
Up toup_todate
The last day to include. Defaults to today.

Outputs

countnumber
How many were returned
customer_idnumber
The customer's id
historylist
The customer's past service, as ServiceWorks lists it
Example output
{
  "count": 1,
  "customer_id": 14563590,
  "history": [
    {
      "JobDescription": "Dryer not heating",
      "TicketNumber": "58037"
    }
  ]
}

Get text messages

Get the text conversation with a customer.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.

Outputs

countnumber
How many were returned
customer_idnumber
The customer's id
messageslist
The messages, as ServiceWorks lists them
Example output
{
  "count": 1,
  "customer_id": 14563590,
  "messages": [
    {
      "MessageText": "See you at 9",
      "ToPhone": "6362228839"
    }
  ]
}

List invoices

List unpaid, paid or canceled invoices from a date range (the last 30 days unless given).

Inputs

Which invoicesstatustext
Unpaid, paid or canceled invoices.One of: due (Unpaid), paid, canceled. Default: due.
Fromfrom_datedate
The first day to include. Defaults to 30 days ago.
Toto_datedate
The last day to include. Defaults to today.
Customer namecustomer_nametext
Only this customer's invoices.
Account numberaccount_numbertext
Only invoices for this account number.
Invoice numberinvoice_numbertext
Only the invoice with this number.
Hide zero invoiceshide_zerotrue/false
Leave out invoices for nothing.Default: false.

Outputs

countnumber
How many were returned
invoiceslist
The invoices, as ServiceWorks lists them
statustext
Which invoices: due, paid or canceled
Example output
{
  "count": 1,
  "invoices": [
    {
      "InvoiceNo": "58037",
      "Name": "Jerry Holland"
    }
  ],
  "status": "due"
}

List payments

List the payments you have received, a page at a time.

Inputs

Pagepagenumber
Which page, starting at 1.From 1 to 10000.
Page sizepage_sizenumber
How many on a page, 1 to 100. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many were returned
pagenumber
The page returned
paymentslist
The payments, as ServiceWorks lists them
Example output
{
  "count": 1,
  "page": 1,
  "payments": [
    {
      "Amount": 110.0,
      "PaymentId": 34081
    }
  ]
}

List schedule

List the jobs on the calendar for up to 31 days (today unless given), for one technician, job type or status if you like.

Inputs

Fromfrom_datedate
The first day to include. Defaults to the 'To' day, or today.
Toto_datedate
The last day to include. Defaults to today.
Techniciantechnician_idtext
Only this technician's jobs.
Job typejob_type_idtext
Only jobs of this type.
Statusstatus_idtext
Only jobs with this status.

Outputs

countnumber
How many were returned
jobslist
The jobs, one row per visit
Example output
{
  "count": 1,
  "jobs": [
    {
      "customer_id": 14563590,
      "details": {
        "CustomerId": 14563590,
        "TicketId": 716519,
        "TicketNumber": "58037",
        "TicketStatus": "Scheduled",
        "TicketStatusId": 2,
        "TripAssignmentId": 723845
      },
      "job_id": 716519,
      "job_number": "58037",
      "status": "Scheduled",
      "status_id": 2,
      "visit_id": 723845
    }
  ]
}

List technicians

List your technicians, or those whose name has some text.

Inputs

Namenametext
Only technicians whose name has this text.

Outputs

countnumber
How many were returned
technicianslist
The technicians
Example output
{
  "count": 1,
  "technicians": [
    {
      "details": {
        "EmployeeId": 1559,
        "EmployeeName": "Robin Wonder"
      },
      "name": "Robin Wonder",
      "technician_id": 1559
    }
  ]
}

Schedule job

Book a job's visit for a day and time, and assign its technicians.

Inputs

Job IDjob_idtextRequired
The job's id, from 'Create job', 'Find jobs' or an earlier step.
Datevisit_datedateRequired
The day of the visit.
Timestart_timetime
The time the visit starts, in your business's own time.
Length in minutesduration_minutesnumber
How long the visit takes. Defaults to its current length.From 5 to 1440.
Arrival windowtime_window_idtext
One of your arrival windows (such as 8 to 12). Leave empty to book for the day.
Technicianstechnician_idslist
The technicians to assign. The first one picked leads the visit.
Visit IDvisit_idtext
Which visit to the job, for a job with more than one. Leave empty for its latest visit.

Outputs

job_idnumber
The job's id
messagetext
ServiceWorks' own confirmation message
scheduled_fortext
The appointment as sent, MM/DD/YYYY hh:mm AM
technician_idslist
The technicians assigned
visit_idnumber
The visit's id
Example output
{
  "job_id": 716519,
  "message": "Success",
  "scheduled_for": "11/24/2026 08:00 AM",
  "technician_ids": [
    1559
  ],
  "visit_id": 723845
}

Send text to customer

Text a customer from your ServiceWorks number, at their main phone unless you give another.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.
MessagemessagetextRequired
The text to send.
Phoneto_phonetext
The number to text. Leave empty for their main phone.

Outputs

customer_idnumber
The customer's id
messagetext
ServiceWorks' own confirmation message
to_phonetext
The number texted
Example output
{
  "customer_id": 14563590,
  "message": "Success",
  "to_phone": "6362228839"
}

Set work performed

Write what was done on a job's visit, the explanation of service shown on its invoice. It replaces any already written.

Inputs

Job IDjob_idtextRequired
The job's id, from 'Create job', 'Find jobs' or an earlier step.
Work performedwork_performedtextRequired
What was done, such as 'Replaced heating element'.
Visit IDvisit_idtext
Which visit to the job, for a job with more than one. Leave empty for its latest visit.

Outputs

job_idnumber
The job's id
messagetext
ServiceWorks' own confirmation message
visit_idnumber
The visit's id
Example output
{
  "job_id": 716519,
  "message": "Success",
  "visit_id": 723845
}

Update customer

Change a customer's name, company, account number, phones, email or update preferences. Only the details given change.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.
First namefirst_nametext
A new first name. Leave empty to keep it.
Last namelast_nametext
A new last name. Leave empty to keep it.
Companycompany_nametext
A new company name. Leave empty to keep it.
Account numberaccount_numbertext
A new account number. Leave empty to keep it.
Phonephonetext
A new main phone number. Leave empty to keep it.
Second phonesecond_phonetext
A new second phone number. Leave empty to keep it.
Emailemailtext
A new email address. Leave empty to keep it.
Email updatesemail_updatestext
Whether ServiceWorks emails the customer about their jobs.One of: on, off.
Text updatestext_updatestext
Whether ServiceWorks texts the customer about their jobs.One of: on, off.

Outputs

customerobject
The customer, as ServiceWorks returns it
customer_idnumber
The customer's id
Example output
{
  "customer": {
    "AccountNumber": "TEST1",
    "Addresses": [
      {
        "AddressId": 15695363,
        "AddressLine1": "1001 Craig Road",
        "AddressLine2": "",
        "City": "ST. LOUIS",
        "CountryCode": "",
        "Email": "jerry.holland@none.com",
        "FirstName": "Starter",
        "IsActive": true,
        "IsParentAddress": false,
        "LastName": "Package",
        "Lat": "38.6725623",
        "Long": "-90.4370574",
        "Note": "",
        "NotifyEmail": false,
        "NotifyPrimaryPhone": false,
        "NotifySecondaryPhone": false,
        "PrimaryPhone": "636 220 4363",
        "SecondaryPhone": "",
        "State": "MO",
        "Type": 2,
        "Zip": "63146"
      }
    ],
    "BillToId": 0,
    "CompanyName": "Jerry Holland Test",
    "Content": [],
    "CustomFields": [
      {
        "FieldId": 1,
        "FieldName": "Industry",
        "FieldType": "Text",
        "FieldTypeId": 1,
        "FieldValue": "Service",
        "Fields": [],
        "MandetoryforInstantBooking": false,
        "MappingId": 142472,
        "SelectedValue": 0
      }
    ],
    "CustomerId": 14563590,
    "CustomerType": 0,
    "Email": "",
    "Finance": {
      "CreditLimit": 0,
      "CurrentDue": 0,
      "IsTaxExempt": false,
      "TaxCode": null
    },
    "FirstName": "Jerry",
    "IsActive": true,
    "ItemPrice": null,
    "LastName": "Holland",
    "LeadStatus": "Test 1",
    "LeadStatusId": 3521,
    "Note": "",
    "ParentId": 0,
    "ParentName": null,
    "PickupPointId": null,
    "PrimaryPhone": "1112223333",
    "PropertyManagementCustomerAccNumber": "",
    "PropertyManagementCustomerId": 0,
    "RedFlag": {
      "CreatedBy": null,
      "CreatedByUserId": 0,
      "IsRedFlagActivated": false,
      "Reason": null,
      "TimeStamp": "0001-01-01T00:00:00"
    },
    "SalesMan": "",
    "SecondaryPhone": null,
    "SendEmial": true,
    "SendTextToPrimaryPhone": true,
    "SendTextToSecondaryPhone": false,
    "Status": 1,
    "Technician": ""
  },
  "customer_id": 14563590
}

Update customer address

Change one of a customer's addresses. Only the parts given change, and their other addresses stay as they are.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Find customers' or an earlier step.
Address IDaddress_idtext
Which address, from the customer's Addresses (AddressId). Leave empty for their first address.
Street addressaddress_line1text
A new street address. Leave empty to keep it.
Apartment or suiteaddress_line2text
A new apartment, suite or unit. Leave empty to keep it.
Citycitytext
A new city. Leave empty to keep it.
Statestatetext
A new state. Leave empty to keep it.
ZIP codezip_codetext
A new ZIP or postal code. Leave empty to keep it.

Outputs

customerobject
The customer, as ServiceWorks returns it
customer_idnumber
The customer's id
Example output
{
  "customer": {
    "AccountNumber": "TEST1",
    "Addresses": [
      {
        "AddressId": 15695363,
        "AddressLine1": "1001 Craig Road",
        "AddressLine2": "",
        "City": "ST. LOUIS",
        "CountryCode": "",
        "Email": "jerry.holland@none.com",
        "FirstName": "Starter",
        "IsActive": true,
        "IsParentAddress": false,
        "LastName": "Package",
        "Lat": "38.6725623",
        "Long": "-90.4370574",
        "Note": "",
        "NotifyEmail": false,
        "NotifyPrimaryPhone": false,
        "NotifySecondaryPhone": false,
        "PrimaryPhone": "636 220 4363",
        "SecondaryPhone": "",
        "State": "MO",
        "Type": 2,
        "Zip": "63146"
      }
    ],
    "BillToId": 0,
    "CompanyName": "Jerry Holland Test",
    "Content": [],
    "CustomFields": [
      {
        "FieldId": 1,
        "FieldName": "Industry",
        "FieldType": "Text",
        "FieldTypeId": 1,
        "FieldValue": "Service",
        "Fields": [],
        "MandetoryforInstantBooking": false,
        "MappingId": 142472,
        "SelectedValue": 0
      }
    ],
    "CustomerId": 14563590,
    "CustomerType": 0,
    "Email": "",
    "Finance": {
      "CreditLimit": 0,
      "CurrentDue": 0,
      "IsTaxExempt": false,
      "TaxCode": null
    },
    "FirstName": "Jerry",
    "IsActive": true,
    "ItemPrice": null,
    "LastName": "Holland",
    "LeadStatus": "Test 1",
    "LeadStatusId": 3521,
    "Note": "",
    "ParentId": 0,
    "ParentName": null,
    "PickupPointId": null,
    "PrimaryPhone": "1112223333",
    "PropertyManagementCustomerAccNumber": "",
    "PropertyManagementCustomerId": 0,
    "RedFlag": {
      "CreatedBy": null,
      "CreatedByUserId": 0,
      "IsRedFlagActivated": false,
      "Reason": null,
      "TimeStamp": "0001-01-01T00:00:00"
    },
    "SalesMan": "",
    "SecondaryPhone": null,
    "SendEmial": true,
    "SendTextToPrimaryPhone": true,
    "SendTextToSecondaryPhone": false,
    "Status": 1,
    "Technician": ""
  },
  "customer_id": 14563590
}

Update job status

Set a job's status, such as completed or canceled.

Inputs

Job IDjob_idtextRequired
The job's id, from 'Create job', 'Find jobs' or an earlier step.
Statusstatus_idtextRequired
The status to set, from your ServiceWorks statuses.
Visit IDvisit_idtext
Which visit to the job, for a job with more than one. Leave empty for its latest visit.

Outputs

job_idnumber
The job's id
messagetext
ServiceWorks' own confirmation message
status_idnumber
The status set
visit_idnumber
The visit's id
Example output
{
  "job_id": 716519,
  "message": "Success",
  "status_id": 2,
  "visit_id": 723845
}

On this page