Workiz
App · 25 actions
Field service software for home service businesses: jobs, leads, scheduling, dispatch, invoices and payments.
Actions
| Action | What it does |
|---|---|
| Add client note | Add a note to a client, pinned to the top if you like. |
| Add payment | Record a cash, credit card or check payment on a job, invoice or estimate. |
| Assign team member | Put a team member on a job or a lead. |
| Convert lead to job | Turn a lead into a job, keeping its client, schedule and team. |
| Create client | Add a client with their contact details and service address. |
| Create job | Create a job for an existing or new client, on the schedule or unscheduled. |
| Create lead | Create a lead for an existing or new client, on the schedule or unscheduled. |
| Find clients | Find clients by name, phone, email or address, by what they owe, or by tags. |
| Get client | Get a client with their notes, other contacts, tags and custom fields. |
| Get invoice | Get an invoice with its line items and payments. |
| Get job | Get a job with its client, schedule, team, line items, payments and notes. |
| Get lead | Get a lead with its client, schedule, team and notes. |
| Get open time slots | Get the times with room for another booking, as Workiz's online booking works them out. |
| List estimates | List estimates by the day they were made or changed. |
| List invoices | List invoices by the day they were made or changed, and whether something is owed. |
| List job types | List the kinds of job the account does, with how long each usually takes. |
| List jobs | List jobs in a range of days, open, closed or both, newest first. |
| List leads | List leads in a range of days, open, lost or both, newest first. |
| List payments | List payments collected, by day, client, status or how they were paid. |
| List team members | List the account's users, such as the field techs jobs can be assigned to. |
| Mark lead lost or active | Mark a lead as lost, or make a lost lead active again. |
| Search | Find jobs, leads, clients and invoices by name, phone, email, address or number. |
| Unassign team member | Take a team member off a job or a lead. |
| Update job | Change a job's status, sub-status, schedule, details, tags, custom fields or client details. |
| Update lead | Change a lead's status, schedule, details, tags, custom fields or client details. |
Add client note
Add a note to a client, pinned to the top if you like.
Inputs
- Client ID
client_idtextRequired - The client's ID, which starts with CL-, from a trigger, 'Find clients' or an earlier step.
- Note
notetextRequired - What the note says.
- Pin to the top
pintrue/false - Pin the note to the top of the client's notes.
Outputs
client_idtext- The client the note is on.
noteobject- A note on a client.
summarytext- What the step did, in a sentence.
Example output
{
"client_id": "CL-OvmDp2yvv1yqMwRl",
"note": {
"author": "Oliver Workiz",
"created_at": "2026-11-01 09:00:00",
"id": "CLN-211d1676f4b90c40",
"note": "Customer requested a follow-up call.",
"pinned": false
},
"summary": "Added a note to the client CL-OvmDp2yvv1yqMwRl."
}Add payment
Record a cash, credit card or check payment on a job, invoice or estimate.
Inputs
- Job, invoice or estimate ID
record_idtextRequired - What was paid: a job (JOB-...), invoice (IV-...) or estimate (ES-...).
- Paid by
payment_typetextRequired - How the client paid.One of:
cash,credit(Credit card),check. - Amount
amountnumberRequired - How much was paid, such as 150.00.
- Paid at
paid_atdate and time - When it was paid. Leave empty for now.
- Time zone
time_zonetext - The time zone the work is in, such as America/New_York. Needed when you pick a start or end with the date-and-time picker.
- Reference
referencetext - A check number or other reference, such as Check #1234.
Outputs
paymentobject- A payment.
record_idtext- What was paid (JOB-, IV- or ES-).
record_typetext- job, invoice or estimate.
summarytext- What the step did, in a sentence.
Example output
{
"payment": {
"amount": 250.5,
"client_id": "CL-OvmDp2yvv1yqMwRl",
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"estimate_id": "",
"id": "PAY-BA5r7o4bqzR9MONa",
"invoice_id": "IV-bK9r2XyZL54aWDR0",
"job_id": "JOB-BA5r7o4bqzR9MONa",
"net_amount": 243.24,
"processing_fee": 0,
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
},
"record_id": "JOB-BA5r7o4bqzR9MONa",
"record_type": "job",
"summary": "Added a cash payment of 250.50 to the job JOB-BA5r7o4bqzR9MONa."
}Assign team member
Put a team member on a job or a lead.
Inputs
- Job or lead ID
record_idtextRequired - The job (JOB-...) or lead (LD-...) to put them on.
- Team member
team_member_idtextRequired - The team member. Pick one, or give their user ID (USR-...).
- Make primary
primarytrue/false - Make them the primary team member on it.
- Replace the current one
replacetrue/false - Take off whoever is on it now. Only works when your Workiz account allows one team member per job.
Outputs
record_idtext- The job or lead it was done to.
record_typetext- job or lead.
summarytext- What the step did, in a sentence.
team_memberobject- Who was assigned.
Example output
{
"record_id": "JOB-BA5r7o4bqzR9MONa",
"record_type": "job",
"summary": "Assigned Oliver Workiz to the job JOB-BA5r7o4bqzR9MONa.",
"team_member": {
"email": "oliver@example.com",
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz",
"primary": true
}
}Convert lead to job
Turn a lead into a job, keeping its client, schedule and team.
Inputs
- Lead ID
lead_idtextRequired - The lead's ID, which starts with LD-, from a trigger or an earlier step.
Outputs
jobobject- The job.
lead_idtext- The lead that was converted.
summarytext- What the step did, in a sentence.
Example output
{
"job": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"amount_due": 956.51,
"amount_due_date": "2026-11-10 10:00:00",
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"converted_at": "2026-11-02 10:00:00",
"converted_from_lead": true,
"created_at": "2026-11-01 09:00:00",
"custom_fields": [
{
"id": "CF-eYLPK7198xVp6Z8q",
"name": "Gate code",
"value": "4411"
}
],
"description": "AC is blowing warm air.",
"discount_amount": 10,
"end": "2026-11-03 12:00:00",
"id": "JOB-BA5r7o4bqzR9MONa",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"line_items": [
{
"description": "Deadbolt replacement, any color and size",
"id": "JLI-BA5r7o4bqzR9MONa",
"name": "Deadbolt",
"price": 100,
"quantity": 1,
"total": 100,
"type": "product"
}
],
"name": "AC Repair",
"notes": [
{
"author": "Oliver Workiz",
"created_at": "2026-11-01 10:00:00",
"id": "JNT-8cddc18e7b0458fa",
"note": "Please call the client before heading there."
}
],
"payments": [
{
"amount": 250.5,
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"id": "PAY-BA5r7o4bqzR9MONa",
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
}
],
"scheduled": true,
"serial_id": 12345,
"start": "2026-11-03 10:00:00",
"status": "Submitted",
"status_updated_at": "2026-11-01 09:00:00",
"sub_status": "Follow Up",
"sub_status_id": "JSS-BA5r7o4bqzR9MONa",
"sub_total": 946,
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"tax_amount": 10.51,
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"tip_amount": 43.51,
"total_price": 956.51,
"updated_at": "2026-11-01 09:05:00",
"updated_at_utc": "2026-11-01 17:05:00",
"url": "https://app.workiz.com/job/3YBIBO/",
"uuid": "3YBIBO"
},
"lead_id": "LD-LwqGJnRwvZPaNe5E",
"summary": "Converted the lead LD-LwqGJnRwvZPaNe5E to job #12345 (AC Repair)."
}Create client
Add a client with their contact details and service address.
Inputs
- First name
first_nametextRequired - The client's first name.
- Last name
last_nametext - The client's last name.
- Company
company_nametext - The client's company.
- Email
emailtext - The client's email address. A new client needs an email or a phone.
- Phone
phonetext - The client's main phone number, such as 6195555555.
- Phone extension
phone_exttext - The main phone's extension.
- Second phone
second_phonetext - Another phone number for the client.
- Street address
addresstext - Where the work is, such as 462 Powell St.
- Unit
unittext - The unit, suite or apartment.
- City
citytext - The city.
- State
statetext - The state or province, such as CA.
- ZIP code
zip_codetext - The ZIP or postal code.
- Country
countrytext - The country, such as US.
- Ad group
ad_group_idtext - The ad group (lead source) the work came from, for Workiz's marketing reports.
- Description
descriptiontext - What the work is about.
- Custom fields
custom_fieldsobject - Values for the account's client custom fields, one box per field.
Outputs
clientobject- The client.
summarytext- What the step did, in a sentence.
Example output
{
"client": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"address": "123 Main St",
"allow_billing": true,
"billing_address": "123 Main St, New York, NY 10001",
"city": "New York",
"company_name": "John Doe Inc.",
"contacts": [
{
"email": "jane.doe@example.com",
"full_name": "Jane Doe",
"id": "CLC-211d1676f4b90c40",
"phone": "1234567892",
"role": "Property Manager"
}
],
"country": "US",
"created_at": "2026-10-01 08:00:00",
"custom_fields": [],
"description": "Prefers morning visits.",
"email": "john.doe@example.com",
"first_name": "John",
"full_address": "123 Main St, New York, NY 10001",
"full_name": "John Doe",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"notes": [
{
"author": "Oliver Workiz",
"created_at": "2026-11-01 09:00:00",
"id": "CLN-211d1676f4b90c40",
"note": "Customer requested a follow-up call.",
"pinned": false
}
],
"phone": "1234567890",
"phone_ext": "123",
"second_phone": "1234567891",
"second_phone_ext": "456",
"serial_id": 1023,
"state": "NY",
"tags": [
{
"id": "TAG-211d1676f4b90c40",
"name": "VIP"
}
],
"tax_exempt": false,
"unit": "100",
"zip_code": "10001"
},
"summary": "Added the client John Doe (CL-OvmDp2yvv1yqMwRl)."
}Create job
Create a job for an existing or new client, on the schedule or unscheduled.
Inputs
- Job type
job_type_idtextRequired - What kind of job it is. Pick one, or give its ID (JT-...).
- Existing client ID
client_idtext - An existing client's ID (CL-...). Leave empty to use the details below: Workiz matches them to a client it has by name, phone, email or address, or adds a new one.
- First name
first_nametext - The client's first name. Needed for a new client.
- Last name
last_nametext - The client's last name.
- Company
company_nametext - The client's company.
- Email
emailtext - The client's email address. A new client needs an email or a phone.
- Phone
phonetext - The client's main phone number, such as 6195555555.
- Phone extension
phone_exttext - The main phone's extension.
- Second phone
second_phonetext - Another phone number for the client.
- Street address
addresstext - Where the work is, such as 462 Powell St.
- Unit
unittext - The unit, suite or apartment.
- City
citytext - The city.
- State
statetext - The state or province, such as CA.
- ZIP code
zip_codetext - The ZIP or postal code.
- Country
countrytext - The country, such as US.
- Job name
nametext - A name for the job, such as AC Repair.
- Description
descriptiontext - What the work is about.
- Start
startdate and time - When the visit starts. Pick a date and time and choose the Time zone, or give a local time such as 2026-11-03 09:00. Leave empty to leave it unscheduled.
- End
enddate and time - When the visit ends. Leave empty for one hour after the start.
- Time zone
time_zonetext - The time zone the work is in, such as America/New_York. Needed when you pick a start or end with the date-and-time picker.
- Ad group
ad_group_idtext - The ad group (lead source) the work came from, for Workiz's marketing reports.
- Custom fields
custom_fieldsobject - Values for the account's job custom fields, one box per field.
Outputs
jobobject- The job.
summarytext- What the step did, in a sentence.
Example output
{
"job": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"amount_due": 956.51,
"amount_due_date": "2026-11-10 10:00:00",
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"converted_at": "",
"converted_from_lead": false,
"created_at": "2026-11-01 09:00:00",
"custom_fields": [
{
"id": "CF-eYLPK7198xVp6Z8q",
"name": "Gate code",
"value": "4411"
}
],
"description": "AC is blowing warm air.",
"discount_amount": 10,
"end": "2026-11-03 12:00:00",
"id": "JOB-BA5r7o4bqzR9MONa",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"line_items": [
{
"description": "Deadbolt replacement, any color and size",
"id": "JLI-BA5r7o4bqzR9MONa",
"name": "Deadbolt",
"price": 100,
"quantity": 1,
"total": 100,
"type": "product"
}
],
"name": "AC Repair",
"notes": [
{
"author": "Oliver Workiz",
"created_at": "2026-11-01 10:00:00",
"id": "JNT-8cddc18e7b0458fa",
"note": "Please call the client before heading there."
}
],
"payments": [
{
"amount": 250.5,
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"id": "PAY-BA5r7o4bqzR9MONa",
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
}
],
"scheduled": true,
"serial_id": 12345,
"start": "2026-11-03 10:00:00",
"status": "Submitted",
"status_updated_at": "2026-11-01 09:00:00",
"sub_status": "Follow Up",
"sub_status_id": "JSS-BA5r7o4bqzR9MONa",
"sub_total": 946,
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"tax_amount": 10.51,
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"tip_amount": 43.51,
"total_price": 956.51,
"updated_at": "2026-11-01 09:05:00",
"updated_at_utc": "2026-11-01 17:05:00",
"url": "https://app.workiz.com/job/3YBIBO/",
"uuid": "3YBIBO"
},
"summary": "Created job #12345 (AC Repair) for John Doe."
}Create lead
Create a lead for an existing or new client, on the schedule or unscheduled.
Inputs
- Existing client ID
client_idtext - An existing client's ID (CL-...). Leave empty to use the details below: Workiz matches them to a client it has by name, phone, email or address, or adds a new one.
- First name
first_nametext - The client's first name. Needed for a new client.
- Last name
last_nametext - The client's last name.
- Company
company_nametext - The client's company.
- Email
emailtext - The client's email address. A new client needs an email or a phone.
- Phone
phonetext - The client's main phone number, such as 6195555555.
- Phone extension
phone_exttext - The main phone's extension.
- Second phone
second_phonetext - Another phone number for the client.
- Street address
addresstext - Where the work is, such as 462 Powell St.
- Unit
unittext - The unit, suite or apartment.
- City
citytext - The city.
- State
statetext - The state or province, such as CA.
- ZIP code
zip_codetext - The ZIP or postal code.
- Country
countrytext - The country, such as US.
- Job type
job_type_idtext - What kind of work it is. Pick one, or give its ID (JT-...).
- Description
descriptiontext - What the work is about.
- Start
startdate and time - When the visit starts. Pick a date and time and choose the Time zone, or give a local time such as 2026-11-03 09:00. Leave empty to leave it unscheduled.
- End
enddate and time - When the visit ends. Leave empty for one hour after the start.
- Time zone
time_zonetext - The time zone the work is in, such as America/New_York. Needed when you pick a start or end with the date-and-time picker.
- Ad group
ad_group_idtext - The ad group (lead source) the work came from, for Workiz's marketing reports.
- Custom fields
custom_fieldsobject - Values for the account's job and lead custom fields, one box per field.
Outputs
leadobject- The lead.
summarytext- What the step did, in a sentence.
Example output
{
"lead": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"created_at": "2026-11-01 09:00:00",
"custom_fields": [],
"description": "Interested in a water heater replacement.",
"end": "2026-11-04 10:00:00",
"id": "LD-LwqGJnRwvZPaNe5E",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"lost": false,
"notes": [],
"scheduled": true,
"serial_id": 795,
"start": "2026-11-04 09:00:00",
"status": "new",
"status_updated_at": "2026-11-01 09:00:00",
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"updated_at": "2026-11-01 09:00:00",
"updated_at_utc": "2026-11-01 17:00:00",
"url": "https://app.workiz.com/lead/GD87TS/",
"uuid": "GD87TS"
},
"summary": "Created lead #795 for John Doe."
}Find clients
Find clients by name, phone, email or address, by what they owe, or by tags.
Inputs
- Search
searchtext - Words to find in the name, company, address, phone, email or custom fields.
- Balance
balancetext - Only clients who owe something, or whose balance is past due.One of:
any(Any balance),Due(Something still owed),PastDue(Past due). Default:any. - Tags
tag_idslist - Only clients with all of these tags.
- Added from
created_fromdate - Only clients added on or after this day.
- Added to
created_todate - Only clients added on or before this day.
- Order
sorttext - How to order them.One of:
newest(Newest first),oldest(Oldest first),name(By name),company(By company). Default:newest. - Page
pagenumber - Which page of results to get. The first is 1.From 1 to 1000. Default:
1. - Page size
page_sizenumber - How many to get per page, 1 to 100.From 1 to 100. Default:
50.
Outputs
clientslist- The clients on this page.
countnumber- How many are on this page.
has_moretrue/false- Whether there is another page.
pagenumber- The page this is (the first is 1).
total_resultsnumber- How many match, across every page.
Example output
{
"clients": [
{
"address": "123 Main St",
"city": "New York",
"company_name": "John Doe Inc.",
"country": "US",
"created_at": "2026-10-01 08:00:00",
"email": "john.doe@example.com",
"first_name": "John",
"full_address": "123 Main St, New York, NY 10001",
"full_name": "John Doe",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"phone": "1234567890",
"phone_ext": "123",
"second_phone": "1234567891",
"second_phone_ext": "456",
"serial_id": 1023,
"state": "NY",
"unit": "100",
"zip_code": "10001"
}
],
"count": 1,
"has_more": false,
"page": 1,
"total_results": 1
}Get client
Get a client with their notes, other contacts, tags and custom fields.
Inputs
- Client ID
client_idtextRequired - The client's ID, which starts with CL-, from a trigger, 'Find clients' or an earlier step.
Outputs
clientobject- The client.
Example output
{
"client": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"address": "123 Main St",
"allow_billing": true,
"billing_address": "123 Main St, New York, NY 10001",
"city": "New York",
"company_name": "John Doe Inc.",
"contacts": [
{
"email": "jane.doe@example.com",
"full_name": "Jane Doe",
"id": "CLC-211d1676f4b90c40",
"phone": "1234567892",
"role": "Property Manager"
}
],
"country": "US",
"created_at": "2026-10-01 08:00:00",
"custom_fields": [],
"description": "Prefers morning visits.",
"email": "john.doe@example.com",
"first_name": "John",
"full_address": "123 Main St, New York, NY 10001",
"full_name": "John Doe",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"notes": [
{
"author": "Oliver Workiz",
"created_at": "2026-11-01 09:00:00",
"id": "CLN-211d1676f4b90c40",
"note": "Customer requested a follow-up call.",
"pinned": false
}
],
"phone": "1234567890",
"phone_ext": "123",
"second_phone": "1234567891",
"second_phone_ext": "456",
"serial_id": 1023,
"state": "NY",
"tags": [
{
"id": "TAG-211d1676f4b90c40",
"name": "VIP"
}
],
"tax_exempt": false,
"unit": "100",
"zip_code": "10001"
}
}Get invoice
Get an invoice with its line items and payments.
Inputs
- Invoice ID
invoice_idtextRequired - The invoice's ID, which starts with IV-, from a trigger or 'List invoices'.
Outputs
invoiceobject- The invoice.
Example output
{
"invoice": {
"amount_due": 706.01,
"amount_due_date": "2026-11-10 10:00:00",
"created_at": "2026-11-03 12:00:00",
"discount_amount": 10,
"id": "IV-bK9r2XyZL54aWDR0",
"job_id": "JOB-BA5r7o4bqzR9MONa",
"line_items": [
{
"description": "Deadbolt replacement, any color and size",
"id": "ILI-BA5r7o4bqzR9MONa",
"name": "Deadbolt",
"price": 100,
"quantity": 1,
"total": 100,
"type": ""
}
],
"name": "Invoice 56",
"notes": "Thank you for your business.",
"paid": false,
"payments": [
{
"amount": 250.5,
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"id": "PAY-BA5r7o4bqzR9MONa",
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
}
],
"serial_id": 56,
"sub_total": 946,
"tax_amount": 10.51,
"tip_amount": 0,
"total_price": 956.51,
"updated_at": "2026-11-03 12:10:00",
"uuid": "3YBIBO"
}
}Get job
Get a job with its client, schedule, team, line items, payments and notes.
Inputs
- Job ID
job_idtextRequired - The job's ID, which starts with JOB-, from a trigger or an earlier step.
Outputs
jobobject- The job.
Example output
{
"job": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"amount_due": 956.51,
"amount_due_date": "2026-11-10 10:00:00",
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"converted_at": "",
"converted_from_lead": false,
"created_at": "2026-11-01 09:00:00",
"custom_fields": [
{
"id": "CF-eYLPK7198xVp6Z8q",
"name": "Gate code",
"value": "4411"
}
],
"description": "AC is blowing warm air.",
"discount_amount": 10,
"end": "2026-11-03 12:00:00",
"id": "JOB-BA5r7o4bqzR9MONa",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"line_items": [
{
"description": "Deadbolt replacement, any color and size",
"id": "JLI-BA5r7o4bqzR9MONa",
"name": "Deadbolt",
"price": 100,
"quantity": 1,
"total": 100,
"type": "product"
}
],
"name": "AC Repair",
"notes": [
{
"author": "Oliver Workiz",
"created_at": "2026-11-01 10:00:00",
"id": "JNT-8cddc18e7b0458fa",
"note": "Please call the client before heading there."
}
],
"payments": [
{
"amount": 250.5,
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"id": "PAY-BA5r7o4bqzR9MONa",
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
}
],
"scheduled": true,
"serial_id": 12345,
"start": "2026-11-03 10:00:00",
"status": "Submitted",
"status_updated_at": "2026-11-01 09:00:00",
"sub_status": "Follow Up",
"sub_status_id": "JSS-BA5r7o4bqzR9MONa",
"sub_total": 946,
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"tax_amount": 10.51,
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"tip_amount": 43.51,
"total_price": 956.51,
"updated_at": "2026-11-01 09:05:00",
"updated_at_utc": "2026-11-01 17:05:00",
"url": "https://app.workiz.com/job/3YBIBO/",
"uuid": "3YBIBO"
}
}Get lead
Get a lead with its client, schedule, team and notes.
Inputs
- Lead ID
lead_idtextRequired - The lead's ID, which starts with LD-, from a trigger or an earlier step.
Outputs
leadobject- The lead.
Example output
{
"lead": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"created_at": "2026-11-01 09:00:00",
"custom_fields": [],
"description": "Interested in a water heater replacement.",
"end": "2026-11-04 10:00:00",
"id": "LD-LwqGJnRwvZPaNe5E",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"lost": false,
"notes": [],
"scheduled": true,
"serial_id": 795,
"start": "2026-11-04 09:00:00",
"status": "new",
"status_updated_at": "2026-11-01 09:00:00",
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"updated_at": "2026-11-01 09:00:00",
"updated_at_utc": "2026-11-01 17:00:00",
"url": "https://app.workiz.com/lead/GD87TS/",
"uuid": "GD87TS"
}
}Get open time slots
Get the times with room for another booking, as Workiz's online booking works them out.
Inputs
- From
start_datedate - The first day to look at. Leave empty for today.
- To
end_datedate - The last day to look at, up to 60 days after From. Leave empty for a month.
- Slot length (minutes)
slot_minutesnumber - How long each slot is, 30 to 480 in steps of 30. Leave empty for the account's setting.From 30 to 480.
- Job types
job_type_idslist - Only count the team members who do these job types.
Outputs
countnumber- How many slots were returned.
slotslist- The open slots, earliest first.
total_resultsnumber- How many open slots there are in those days.
Example output
{
"count": 1,
"slots": [
{
"busy_team_member_ids": [
"USR-38c1ee5c4efa38a4"
],
"length_minutes": 60,
"open_spots": 2,
"start": "2026-11-05 09:00",
"start_utc": "2026-11-05T14:00:00Z",
"total_spots": 3
}
],
"total_results": 1
}List estimates
List estimates by the day they were made or changed.
Inputs
- Date to filter on
date_fieldtext - Which date From and To apply to: when the estimate was created or last changed.One of:
created,updated(Last updated). Default:created. - From
from_datedate - The first day to include.
- To
to_datedate - The last day to include. At most a year after From.
- Order
sorttext - Newest or oldest first.One of:
newest(Newest first),oldest(Oldest first). Default:newest. - Page
pagenumber - Which page of results to get. The first is 1.From 1 to 1000. Default:
1. - Page size
page_sizenumber - How many to get per page, 1 to 100.From 1 to 100. Default:
50.
Outputs
countnumber- How many are on this page.
estimateslist- The estimates on this page.
has_moretrue/false- Whether there is another page.
pagenumber- The page this is (the first is 1).
total_resultsnumber- How many match, across every page.
Example output
{
"count": 1,
"estimates": [
{
"client_id": "CL-OvmDp2yvv1yqMwRl",
"created_at": "2026-11-02 09:30:00",
"decline_reason": "",
"deposit": 20,
"deposit_is_percentage": true,
"description": "Replace the water heater.",
"id": "ES-LwqGJnRwvZPaNe5E",
"job_id": "LD-LwqGJnRwvZPaNe5E",
"last_viewed_at": "2026-11-02 18:00:00",
"name": "Estimate 1",
"notes": "Valid for 30 days.",
"sent_at": "2026-11-02 10:00:00",
"serial_id": "1-1",
"status": "Pending",
"status_updated_at": "2026-11-02 10:00:00",
"sub_total": 1200,
"tax_amount": 120,
"total": 1320,
"updated_at": "2026-11-02 18:00:00"
}
],
"has_more": false,
"page": 1,
"total_results": 1
}List invoices
List invoices by the day they were made or changed, and whether something is owed.
Inputs
- Balance
balancetext - Only invoices with something still owed, or past due.One of:
any(Any balance),Due(Something still owed),PastDue(Past due). Default:any. - Date to filter on
date_fieldtext - Which date From and To apply to: when the invoice was created or last changed.One of:
created,updated(Last updated). Default:created. - From
from_datedate - The first day to include.
- To
to_datedate - The last day to include. At most a year after From.
- Order
sorttext - Newest or oldest first.One of:
newest(Newest first),oldest(Oldest first). Default:newest. - Page
pagenumber - Which page of results to get. The first is 1.From 1 to 1000. Default:
1. - Page size
page_sizenumber - How many to get per page, 1 to 100.From 1 to 100. Default:
50.
Outputs
countnumber- How many are on this page.
has_moretrue/false- Whether there is another page.
invoiceslist- The invoices on this page.
pagenumber- The page this is (the first is 1).
total_resultsnumber- How many match, across every page.
Example output
{
"count": 1,
"has_more": false,
"invoices": [
{
"amount_due": 706.01,
"amount_due_date": "2026-11-10 10:00:00",
"created_at": "2026-11-03 12:00:00",
"id": "IV-bK9r2XyZL54aWDR0",
"job_id": "JOB-BA5r7o4bqzR9MONa",
"name": "Invoice 56",
"notes": "Thank you for your business.",
"paid": false,
"serial_id": 56,
"sub_total": 946,
"tax_amount": 10.51,
"tip_amount": 0,
"total_price": 956.51,
"updated_at": "2026-11-03 12:10:00",
"uuid": "3YBIBO"
}
],
"page": 1,
"total_results": 1
}List job types
List the kinds of job the account does, with how long each usually takes.
Inputs
- Include switched-off types
include_disabledtrue/false - Include job types that are switched off.
Outputs
countnumber- How many there are.
job_typeslist- The job types.
Example output
{
"count": 1,
"job_types": [
{
"average_minutes": 120,
"disabled": false,
"id": "JT-8718036049ec4c4d",
"name": "Repair"
}
]
}List jobs
List jobs in a range of days, open, closed or both, newest first.
Inputs
- Jobs to list
status_filtertext - Open jobs, closed jobs (Done or Canceled), or both.One of:
all(Open and closed jobs),open(Open jobs only),closed(Closed jobs only (Done or Canceled)). Default:all. - Date to filter on
date_fieldtext - Which date From and To apply to. With no dates, Workiz lists the last 30 days by scheduled start.One of:
date(Scheduled start),endDate(Scheduled end),created,updated(Last updated). Default:date. - From
from_datedate - The first day to include.
- To
to_datedate - The last day to include. At most a year after From.
- Order
sorttext - How to order them.One of:
created_desc(Newest first),created_asc(Oldest first),updated_desc(Recently updated first),status_desc(Recent status changes first). Default:created_desc. - Page
pagenumber - Which page of results to get. The first is 1.From 1 to 1000. Default:
1. - Page size
page_sizenumber - How many to get per page, 1 to 100.From 1 to 100. Default:
50.
Outputs
countnumber- How many are on this page.
date_rangeobject- The dates the list covers.
has_moretrue/false- Whether there is another page.
jobslist- The jobs on this page.
pagenumber- The page this is (the first is 1).
total_resultsnumber- How many match, across every page.
Example output
{
"count": 1,
"date_range": {
"date_field": "date",
"from_date": "2026-10-04",
"to_date": "2026-11-03"
},
"has_more": false,
"jobs": [
{
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"amount_due": 956.51,
"amount_due_date": "2026-11-10 10:00:00",
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"converted_at": "",
"converted_from_lead": false,
"created_at": "2026-11-01 09:00:00",
"custom_fields": [
{
"id": "CF-eYLPK7198xVp6Z8q",
"name": "Gate code",
"value": "4411"
}
],
"description": "AC is blowing warm air.",
"discount_amount": 10,
"end": "2026-11-03 12:00:00",
"id": "JOB-BA5r7o4bqzR9MONa",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"line_items": [
{
"description": "Deadbolt replacement, any color and size",
"id": "JLI-BA5r7o4bqzR9MONa",
"name": "Deadbolt",
"price": 100,
"quantity": 1,
"total": 100,
"type": "product"
}
],
"name": "AC Repair",
"notes": [
{
"author": "Oliver Workiz",
"created_at": "2026-11-01 10:00:00",
"id": "JNT-8cddc18e7b0458fa",
"note": "Please call the client before heading there."
}
],
"payments": [
{
"amount": 250.5,
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"id": "PAY-BA5r7o4bqzR9MONa",
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
}
],
"scheduled": true,
"serial_id": 12345,
"start": "2026-11-03 10:00:00",
"status": "Submitted",
"status_updated_at": "2026-11-01 09:00:00",
"sub_status": "Follow Up",
"sub_status_id": "JSS-BA5r7o4bqzR9MONa",
"sub_total": 946,
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"tax_amount": 10.51,
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"tip_amount": 43.51,
"total_price": 956.51,
"updated_at": "2026-11-01 09:05:00",
"updated_at_utc": "2026-11-01 17:05:00",
"url": "https://app.workiz.com/job/3YBIBO/",
"uuid": "3YBIBO"
}
],
"page": 1,
"total_results": 1
}List leads
List leads in a range of days, open, lost or both, newest first.
Inputs
- Leads to list
status_filtertext - Open leads, lost leads, or both.One of:
all(Open and lost leads),open(Open leads only),lost(Lost leads only). Default:all. - Date to filter on
date_fieldtext - Which date From and To apply to. With no dates, Workiz lists the last 30 days by scheduled start.One of:
date(Scheduled start),endDate(Scheduled end),created,updated(Last updated). Default:date. - From
from_datedate - The first day to include.
- To
to_datedate - The last day to include. At most a year after From.
- Order
sorttext - How to order them.One of:
created_desc(Newest first),created_asc(Oldest first),updated_desc(Recently updated first),status_desc(Recent status changes first). Default:created_desc. - Page
pagenumber - Which page of results to get. The first is 1.From 1 to 1000. Default:
1. - Page size
page_sizenumber - How many to get per page, 1 to 100.From 1 to 100. Default:
50.
Outputs
countnumber- How many are on this page.
date_rangeobject- The dates the list covers.
has_moretrue/false- Whether there is another page.
leadslist- The leads on this page.
pagenumber- The page this is (the first is 1).
total_resultsnumber- How many match, across every page.
Example output
{
"count": 1,
"date_range": {
"date_field": "date",
"from_date": "2026-10-04",
"to_date": "2026-11-03"
},
"has_more": false,
"leads": [
{
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"created_at": "2026-11-01 09:00:00",
"custom_fields": [],
"description": "Interested in a water heater replacement.",
"end": "2026-11-04 10:00:00",
"id": "LD-LwqGJnRwvZPaNe5E",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"lost": false,
"notes": [],
"scheduled": true,
"serial_id": 795,
"start": "2026-11-04 09:00:00",
"status": "new",
"status_updated_at": "2026-11-01 09:00:00",
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"updated_at": "2026-11-01 09:00:00",
"updated_at_utc": "2026-11-01 17:00:00",
"url": "https://app.workiz.com/lead/GD87TS/",
"uuid": "GD87TS"
}
],
"page": 1,
"total_results": 1
}List payments
List payments collected, by day, client, status or how they were paid.
Inputs
- Client ID
client_idtext - Only payments from this client (CL-...).
- Statuses
statuseslist - Only payments in these statuses.One or more of:
succeeded,pending,failed. - Paid by
payment_typeslist - Only payments made these ways.One or more of:
cash,credit(Credit card (recorded)),check,charge(Card charged in Workiz),refund,refund_offline(Refund (recorded)),bank_transfer(Bank transfer),bank_transfer_offline(Bank transfer (recorded)),cash_app(Cash App),consumer_financing(Consumer financing), and 6 more. - From
from_datedate - The first day the payments were collected on.
- To
to_datedate - The last day the payments were collected on. At most a year after From.
- Order
sorttext - Newest or oldest first.One of:
newest(Newest first),oldest(Oldest first). Default:newest. - Page
pagenumber - Which page of results to get. The first is 1.From 1 to 1000. Default:
1. - Page size
page_sizenumber - How many to get per page, 1 to 100.From 1 to 100. Default:
50.
Outputs
countnumber- How many are on this page.
has_moretrue/false- Whether there is another page.
pagenumber- The page this is (the first is 1).
paymentslist- The payments on this page.
total_resultsnumber- How many match, across every page.
Example output
{
"count": 1,
"has_more": false,
"page": 1,
"payments": [
{
"amount": 250.5,
"client_id": "CL-OvmDp2yvv1yqMwRl",
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"estimate_id": "",
"id": "PAY-BA5r7o4bqzR9MONa",
"invoice_id": "IV-bK9r2XyZL54aWDR0",
"job_id": "JOB-BA5r7o4bqzR9MONa",
"net_amount": 243.24,
"processing_fee": 0,
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
}
],
"total_results": 1
}List team members
List the account's users, such as the field techs jobs can be assigned to.
Inputs
- Field techs only
field_techs_onlytrue/false - Only the people who can be assigned to jobs.
- Include inactive users
include_inactivetrue/false - Include users whose accounts are switched off.
Outputs
countnumber- How many there are.
team_memberslist- The team members.
Example output
{
"count": 1,
"team_members": [
{
"active": true,
"email": "oliver@example.com",
"field_tech": true,
"id": "USR-38c1ee5c4efa38a4",
"job_types": [
"Repair"
],
"name": "Oliver Workiz",
"phone": "6195550100",
"role": "tech",
"service_areas": [
"San Francisco"
]
}
]
}Mark lead lost or active
Mark a lead as lost, or make a lost lead active again.
Inputs
- Lead ID
lead_idtextRequired - The lead's ID, which starts with LD-, from a trigger or an earlier step.
- Mark the lead
statetextRequired - Lost, or active again.One of:
lost(Mark lost),active(Make active again).
Outputs
leadobject- The lead.
summarytext- What the step did, in a sentence.
Example output
{
"lead": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"created_at": "2026-11-01 09:00:00",
"custom_fields": [],
"description": "Interested in a water heater replacement.",
"end": "2026-11-04 10:00:00",
"id": "LD-LwqGJnRwvZPaNe5E",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"lost": true,
"notes": [],
"scheduled": true,
"serial_id": 795,
"start": "2026-11-04 09:00:00",
"status": "new",
"status_updated_at": "2026-11-01 09:00:00",
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"updated_at": "2026-11-01 09:00:00",
"updated_at_utc": "2026-11-01 17:00:00",
"url": "https://app.workiz.com/lead/GD87TS/",
"uuid": "GD87TS"
},
"summary": "Marked lost: lead #795."
}Search
Find jobs, leads, clients and invoices by name, phone, email, address or number.
Inputs
- Search for
termtextRequired - A name, phone number, email, address or job, lead or invoice number.
- Look in
record_typetext - Where to look.One of:
all(Jobs, leads, clients and invoices),job(Jobs),lead(Leads),client(Clients),invoice(Invoices). Default:all. - Matches of each kind
limitnumber - How many matches to get of each kind, 1 to 15.From 1 to 15. Default:
5.
Outputs
countnumber- How many matched.
resultslist- The matches, best first.
Example output
{
"count": 2,
"results": [
{
"address": "462 Powell St, San Francisco, CA 94102",
"amount_due": null,
"client_name": "John Doe",
"company_name": "Sample Company name",
"date": "2026-11-03 10:00:00",
"email": "client@workiz.com",
"id": "JOB-BA5r7o4bqzR9MONa",
"name": "AC Repair",
"phone": "6195555555",
"serial_id": 12345,
"status": "Submitted",
"total_price": null,
"type": "job",
"uuid": "3YBIBO"
},
{
"address": "462 Powell St, San Francisco, CA 94102",
"amount_due": null,
"client_name": "John Doe",
"company_name": "Sample Company name",
"date": "",
"email": "client@workiz.com",
"id": "CL-OvmDp2yvv1yqMwRl",
"name": "John Doe",
"phone": "6195555555",
"serial_id": 1023,
"status": "",
"total_price": null,
"type": "client",
"uuid": ""
}
]
}Unassign team member
Take a team member off a job or a lead.
Inputs
- Job or lead ID
record_idtextRequired - The job (JOB-...) or lead (LD-...) to take them off.
- Team member
team_member_idtextRequired - The team member. Pick one, or give their user ID (USR-...).
Outputs
record_idtext- The job or lead it was done to.
record_typetext- job or lead.
removedtrue/false- Whether they were taken off.
summarytext- What the step did, in a sentence.
team_member_idtext- Who was taken off (USR-...).
Example output
{
"record_id": "JOB-BA5r7o4bqzR9MONa",
"record_type": "job",
"removed": true,
"summary": "Took USR-38c1ee5c4efa38a4 off the job JOB-BA5r7o4bqzR9MONa.",
"team_member_id": "USR-38c1ee5c4efa38a4"
}Update job
Change a job's status, sub-status, schedule, details, tags, custom fields or client details.
Inputs
- Job ID
job_idtextRequired - The job's ID, which starts with JOB-, from a trigger or an earlier step.
- Status
statustext - The job's new status.One of:
Submitted,In progress,Pending,done pending approval,Canceled,Done. - Sub-status
sub_status_idtext - The job's new sub-status, under its status.
- New start
startdate and time - Move the visit to start then. Pick a date and time and choose the Time zone, or give a local time such as 2026-11-03 09:00.
- New end
enddate and time - When the visit now ends. Leave empty to keep its length.
- Time zone
time_zonetext - The time zone the work is in, such as America/New_York. Needed when you pick a start or end with the date-and-time picker.
- Take off the schedule
unscheduletrue/false - Take the visit off the schedule, keeping it as unscheduled.
- Job name
nametext - The job's new name.
- Description
descriptiontext - What the work is about.
- Job type
job_type_idtext - What kind of work it is. Pick one, or give its ID (JT-...).
- Ad group
ad_group_idtext - The ad group (lead source) the work came from, for Workiz's marketing reports.
- Tags
tag_idslist - Sets the job's tags to these. Leave empty to keep its tags.
- Custom fields
custom_fieldsobject - Values for the account's job custom fields, one box per field.
- Client first name
first_nametext - Change the client's first name on it.
- Client last name
last_nametext - Change the client's last name on it.
- Client company
company_nametext - Change the client's company on it.
- Client email
emailtext - Change the client's email address on it.
- Client phone
phonetext - Change the client's main phone number on it.
- Street address
addresstext - Where the work is, such as 462 Powell St.
- Unit
unittext - The unit, suite or apartment.
- City
citytext - The city.
- State
statetext - The state or province, such as CA.
- ZIP code
zip_codetext - The ZIP or postal code.
- Country
countrytext - The country, such as US.
Outputs
jobobject- The job.
summarytext- What the step did, in a sentence.
Example output
{
"job": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"amount_due": 956.51,
"amount_due_date": "2026-11-10 10:00:00",
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"converted_at": "",
"converted_from_lead": false,
"created_at": "2026-11-01 09:00:00",
"custom_fields": [
{
"id": "CF-eYLPK7198xVp6Z8q",
"name": "Gate code",
"value": "4411"
}
],
"description": "AC is blowing warm air.",
"discount_amount": 10,
"end": "2026-11-03 12:00:00",
"id": "JOB-BA5r7o4bqzR9MONa",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"line_items": [
{
"description": "Deadbolt replacement, any color and size",
"id": "JLI-BA5r7o4bqzR9MONa",
"name": "Deadbolt",
"price": 100,
"quantity": 1,
"total": 100,
"type": "product"
}
],
"name": "AC Repair",
"notes": [
{
"author": "Oliver Workiz",
"created_at": "2026-11-01 10:00:00",
"id": "JNT-8cddc18e7b0458fa",
"note": "Please call the client before heading there."
}
],
"payments": [
{
"amount": 250.5,
"collected_by_id": "USR-38c1ee5c4efa38a4",
"confirmation_code": "Check #1234",
"date": "2026-11-03 12:10:00",
"id": "PAY-BA5r7o4bqzR9MONa",
"status": "succeeded",
"tip_amount": 10,
"type": "cash"
}
],
"scheduled": true,
"serial_id": 12345,
"start": "2026-11-03 10:00:00",
"status": "Submitted",
"status_updated_at": "2026-11-01 09:00:00",
"sub_status": "Follow Up",
"sub_status_id": "JSS-BA5r7o4bqzR9MONa",
"sub_total": 946,
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"tax_amount": 10.51,
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"tip_amount": 43.51,
"total_price": 956.51,
"updated_at": "2026-11-01 09:05:00",
"updated_at_utc": "2026-11-01 17:05:00",
"url": "https://app.workiz.com/job/3YBIBO/",
"uuid": "3YBIBO"
},
"summary": "Updated job #12345 (AC Repair)."
}Update lead
Change a lead's status, schedule, details, tags, custom fields or client details.
Inputs
- Lead ID
lead_idtextRequired - The lead's ID, which starts with LD-, from a trigger or an earlier step.
- Status
statustext - The lead's new status, one of the account's lead statuses.
- New start
startdate and time - Move the visit to start then. Pick a date and time and choose the Time zone, or give a local time such as 2026-11-03 09:00.
- New end
enddate and time - When the visit now ends. Leave empty to keep its length.
- Time zone
time_zonetext - The time zone the work is in, such as America/New_York. Needed when you pick a start or end with the date-and-time picker.
- Take off the schedule
unscheduletrue/false - Take the visit off the schedule, keeping it as unscheduled.
- Description
descriptiontext - What the work is about.
- Job type
job_type_idtext - What kind of work it is. Pick one, or give its ID (JT-...).
- Ad group
ad_group_idtext - The ad group (lead source) the work came from, for Workiz's marketing reports.
- Tags
tag_idslist - Sets the lead's tags to these. Leave empty to keep its tags.
- Custom fields
custom_fieldsobject - Values for the account's job and lead custom fields, one box per field.
- Client first name
first_nametext - Change the client's first name on it.
- Client last name
last_nametext - Change the client's last name on it.
- Client company
company_nametext - Change the client's company on it.
- Client email
emailtext - Change the client's email address on it.
- Client phone
phonetext - Change the client's main phone number on it.
- Street address
addresstext - Where the work is, such as 462 Powell St.
- Unit
unittext - The unit, suite or apartment.
- City
citytext - The city.
- State
statetext - The state or province, such as CA.
- ZIP code
zip_codetext - The ZIP or postal code.
- Country
countrytext - The country, such as US.
Outputs
leadobject- The lead.
summarytext- What the step did, in a sentence.
Example output
{
"lead": {
"ad_group": "Google Ads",
"ad_group_id": "AG-71b8d7310acbf8cc",
"all_day": false,
"client": {
"address": "462 Powell St",
"city": "San Francisco",
"company_name": "Sample Company name",
"country": "US",
"email": "client@workiz.com",
"first_name": "John",
"full_address": "462 Powell St, San Francisco, CA 94102",
"id": "CL-OvmDp2yvv1yqMwRl",
"last_name": "Doe",
"latitude": 37.7887,
"longitude": -122.4087,
"phone": "6195555555",
"phone_ext": "619",
"second_phone": "6195555556",
"second_phone_ext": "613",
"serial_id": 1023,
"service_area": "San Francisco",
"state": "CA",
"unit": "3422",
"zip_code": "94102"
},
"created_at": "2026-11-01 09:00:00",
"custom_fields": [],
"description": "Interested in a water heater replacement.",
"end": "2026-11-04 10:00:00",
"id": "LD-LwqGJnRwvZPaNe5E",
"job_type": "Repair",
"job_type_id": "JT-8718036049ec4c4d",
"lost": false,
"notes": [],
"scheduled": true,
"serial_id": 795,
"start": "2026-11-04 09:00:00",
"status": "new",
"status_updated_at": "2026-11-01 09:00:00",
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "Oliver Workiz"
}
],
"updated_at": "2026-11-01 09:00:00",
"updated_at_utc": "2026-11-01 17:00:00",
"url": "https://app.workiz.com/lead/GD87TS/",
"uuid": "GD87TS"
},
"summary": "Updated lead #795."
}