Manage Workiz jobs and leads: create, update, assign team members and convert leads to jobs.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: change a lost lead back to active. Workiz: POST /lead/activate/{UUID}/.
The lead's UUID (e.g. XYZ56X).
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
WRITE: change a lost lead back to active. Workiz: POST /lead/activate/{UUID}/.
| Argument | Type | Description |
|---|---|---|
| uuid* | string | The lead's UUID (e.g. XYZ56X). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"uuid"
],
"properties": {
"uuid": {
"type": "string",
"minLength": 1,
"description": "The lead's UUID (e.g. XYZ56X)."
}
}
}WRITE: assign a team member (by name) to a job. Reversible with workiz_unassign_job. Workiz: POST /job/assign/.
| Argument | Type | Description |
|---|---|---|
| UUID* | string | The job's UUID (e.g. XYZ56X). |
| User* | string | The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"UUID",
"User"
],
"properties": {
"UUID": {
"type": "string",
"minLength": 1,
"description": "The job's UUID (e.g. XYZ56X)."
},
"User": {
"type": "string",
"minLength": 1,
"description": "The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team."
}
}
}WRITE: assign a team member (by name) to a lead. Reversible with workiz_unassign_lead. Workiz: POST /lead/assign/.
| Argument | Type | Description |
|---|---|---|
| UUID* | string | The lead's UUID (e.g. XYZ56X). |
| User* | string | The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"UUID",
"User"
],
"properties": {
"UUID": {
"type": "string",
"minLength": 1,
"description": "The lead's UUID (e.g. XYZ56X)."
},
"User": {
"type": "string",
"minLength": 1,
"description": "The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team."
}
}
}WRITE (no API undo): convert a lead into a job. Creates a new job from the lead and returns its UUID and link; the API cannot reverse the conversion. Workiz: POST /lead/convert/.
| Argument | Type | Description |
|---|---|---|
| UUID* | string | The lead's UUID (e.g. XYZ56X). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"UUID"
],
"properties": {
"UUID": {
"type": "string",
"minLength": 1,
"description": "The lead's UUID (e.g. XYZ56X)."
}
}
}WRITE: create a new job (schedule, client contact and address, type, source, notes). Returns the new job's UUID, ClientId and app link. Workiz: POST /job/create/.
| Argument | Type | Description |
|---|---|---|
| City | string | City. |
| Unit | string | Unit / apartment. |
| string | Client email. | |
| Phone | string | Primary phone, digits only, e.g. 6195555555. |
| State | string | State, e.g. CA. |
| Address | string | Street address, e.g. 123 W Main Street. |
| Company | string | Client company name. |
| Country | string | Country code, e.g. US. |
| Created | string | Creation timestamp to record. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| JobType | string | Job type, e.g. Repair. |
WRITE: create a new lead (client contact and address, requested time, job type, source, notes). Returns the new lead's UUID, ClientId and app link. Workiz: POST /lead/create/.
| Argument | Type | Description |
|---|---|---|
| City | string | City. |
| Unit | string | Unit / apartment. |
| string | Client email. | |
| Phone | string | Primary phone, digits only, e.g. 6195555555. |
| State | string | State, e.g. CA. |
| Address | string | Street address, e.g. 123 W Main Street. |
| Company | string | Client company name. |
| Country | string | Country code, e.g. US. |
| Created | string | Creation timestamp to record. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| JobType | string |
Fetch one job by UUID: schedule, status, client contact and address, totals and amount due, notes, tags and assigned team. Workiz: GET /job/get/{UUID}/.
| Argument | Type | Description |
|---|---|---|
| uuid* | string | The job's UUID (e.g. XYZ56X). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"uuid"
],
"properties": {
"uuid": {
"type": "string",
"minLength": 1,
"description": "The job's UUID (e.g. XYZ56X)."
}
}
}Fetch one lead by UUID: schedule, status, client contact and address, source, notes and assigned team. Workiz: GET /lead/get/{UUID}/.
| Argument | Type | Description |
|---|---|---|
| uuid* | string | The lead's UUID (e.g. XYZ56X). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"uuid"
],
"properties": {
"uuid": {
"type": "string",
"minLength": 1,
"description": "The lead's UUID (e.g. XYZ56X)."
}
}
}Fetch one team member by user id: name, role, field-tech flag, email, service areas, skills and active status. Workiz: GET /team/get/{USER_ID}.
| Argument | Type | Description |
|---|---|---|
| user_id* | string | The user's id, from workiz_list_team. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"description": "The user's id, from workiz_list_team."
}
}
}List one team member's FUTURE time off, by their name. Workiz: GET /TimeOff/get/{USER_NAME}.
| Argument | Type | Description |
|---|---|---|
| user_name* | string | The team member's name as Workiz shows it, e.g. Joe Acme. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_name"
],
"properties": {
"user_name": {
"type": "string",
"minLength": 1,
"description": "The team member's name as Workiz shows it, e.g. Joe Acme."
}
}
}List jobs, most recently scheduled first (sorted by JobDateTime, descending). Filter by start date, open-only, and status; page with offset/records (max 100). Without start_date Workiz returns the last 14 days. Workiz: GET /job/all/.
| Argument | Type | Description |
|---|---|---|
| offset | integer | Record offset for paging (default 0). |
| status | array | Only these statuses, e.g. ["Submitted", "In progress"]. |
| records | integer | Number of records to return, 1-100 (default 100). |
| only_open | boolean | Only open records, excluding Done and Canceled statuses (Workiz default: true). |
| start_date | string | Return records from this date (yyyy-MM-dd) until today. For jobs, Workiz defaults to the last 14 days when omitted. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Record offset for paging (default 0)."
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only these statuses, e.g. [\"Submitted\", \"In progress\"]."
},
"records": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Number of records to return, 1-100 (default 100)."
},
"only_open": {
"type": "boolean",
"description": "Only open records, excluding Done and Canceled statuses (Workiz default: true)."
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Return records from this date (yyyy-MM-dd) until today. For jobs, Workiz defaults to the last 14 days when omitted."
}
}
}List leads, most recent first (sorted by LeadDateTime, descending). Filter by start date, open-only, and status; page with offset/records (max 100). Workiz: GET /lead/all/.
| Argument | Type | Description |
|---|---|---|
| offset | integer | Record offset for paging (default 0). |
| status | array | Only these statuses, e.g. ["Submitted", "In progress"]. |
| records | integer | Number of records to return, 1-100 (default 100). |
| only_open | boolean | Only open records, excluding Done and Canceled statuses (Workiz default: true). |
| start_date | string | Return records from this date (yyyy-MM-dd) until today. For jobs, Workiz defaults to the last 14 days when omitted. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Record offset for paging (default 0)."
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only these statuses, e.g. [\"Submitted\", \"In progress\"]."
},
"records": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Number of records to return, 1-100 (default 100)."
},
"only_open": {
"type": "boolean",
"description": "Only open records, excluding Done and Canceled statuses (Workiz default: true)."
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Return records from this date (yyyy-MM-dd) until today. For jobs, Workiz defaults to the last 14 days when omitted."
}
}
}List the account's active team members: id, name, role, whether they are a field tech, email, service areas and skills. Use the name to assign people to jobs or leads. Workiz: GET /team/all/.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List FUTURE time off (start, end, userName — 'Entire Business' for company-wide closures). Set all=true to include every user and company time off. Useful before scheduling. Workiz: GET /TimeOff/get/.
| Argument | Type | Description |
|---|---|---|
| all | boolean | Include all users' and company time off (Workiz default: false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"all": {
"type": "boolean",
"description": "Include all users' and company time off (Workiz default: false)."
}
}
}WRITE: mark a lead as lost. Reversible with workiz_activate_lead. Workiz: POST /lead/markLost/{UUID}/.
| Argument | Type | Description |
|---|---|---|
| uuid* | string | The lead's UUID (e.g. XYZ56X). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"uuid"
],
"properties": {
"uuid": {
"type": "string",
"minLength": 1,
"description": "The lead's UUID (e.g. XYZ56X)."
}
}
}WRITE: remove a team member (by name) from a job. Reversible with workiz_assign_job. Workiz: POST /job/unassign/.
| Argument | Type | Description |
|---|---|---|
| UUID* | string | The job's UUID (e.g. XYZ56X). |
| User* | string | The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"UUID",
"User"
],
"properties": {
"UUID": {
"type": "string",
"minLength": 1,
"description": "The job's UUID (e.g. XYZ56X)."
},
"User": {
"type": "string",
"minLength": 1,
"description": "The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team."
}
}
}WRITE: remove a team member (by name) from a lead. Reversible with workiz_assign_lead. Workiz: POST /lead/unassign/.
| Argument | Type | Description |
|---|---|---|
| UUID* | string | The lead's UUID (e.g. XYZ56X). |
| User* | string | The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"UUID",
"User"
],
"properties": {
"UUID": {
"type": "string",
"minLength": 1,
"description": "The lead's UUID (e.g. XYZ56X)."
},
"User": {
"type": "string",
"minLength": 1,
"description": "The team member's NAME exactly as Workiz shows it (e.g. Alex Wilson) — see workiz_list_team."
}
}
}WRITE: update fields on an existing job — status/sub-status, reschedule (JobDateTime/JobEndDateTime), contact, address, type, source, notes, tags. Only the fields you pass are sent. Workiz: POST /job/update/.
| Argument | Type | Description |
|---|---|---|
| City | string | City. |
| Tags | array | Job tags, e.g. ["estimate", "callback"]. |
| UUID* | string | The job's UUID (e.g. XYZ56X). |
| Unit | string | Unit / apartment. |
| string | Client email. | |
| Phone | string | Primary phone, digits only, e.g. 6195555555. |
| State | string | State, e.g. CA. |
| Status | string | New job status, e.g. "In progress". |
| Address | string | Street address, e.g. 123 W Main Street. |
| Company | string |
WRITE: update fields on an existing lead — status, schedule, contact, address, type, source, notes, tags. Only the fields you pass are sent. Workiz: POST /lead/update/.
| Argument | Type | Description |
|---|---|---|
| City | string | City. |
| Tags | array | Lead tags, e.g. ["estimate", "callback"]. |
| UUID* | string | The lead's UUID (e.g. XYZ56X). |
| Unit | string | Unit / apartment. |
| string | Client email. | |
| Phone | string | Primary phone, digits only, e.g. 6195555555. |
| State | string | State, e.g. CA. |
| Status | string | New lead status, e.g. "In progress". |
| Address | string | Street address, e.g. 123 W Main Street. |
| Company | string |
| ClientId | integer | Existing Workiz client id to attach this to. |
| JobNotes | string | Internal job notes. |
| LastName | string | Client last name. |
| PhoneExt | string | Primary phone extension. |
| Timezone | string | Timezone, e.g. US/Pacific. |
| CreatedBy | string | Name recorded as the creator. |
| FirstName | string | Client first name. |
| JobSource | string | Lead/job source, e.g. Google. |
| PostalCode | string | Postal / ZIP code. |
| JobDateTime | string | Scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| SecondPhone | string | Secondary phone. |
| ServiceArea | string | Service area, e.g. metro1. |
| JobEndDateTime | string | Scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| SecondPhoneExt | string | Secondary phone extension. |
| ReferralCompany | string | Referral company, e.g. Thumbtack. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"City": {
"type": "string",
"description": "City."
},
"Unit": {
"type": "string",
"description": "Unit / apartment."
},
"Email": {
"type": "string",
"description": "Client email."
},
"Phone": {
"type": "string",
"description": "Primary phone, digits only, e.g. 6195555555."
},
"State": {
"type": "string",
"description": "State, e.g. CA."
},
"Address": {
"type": "string",
"description": "Street address, e.g. 123 W Main Street."
},
"Company": {
"type": "string",
"description": "Client company name."
},
"Country": {
"type": "string",
"description": "Country code, e.g. US."
},
"Created": {
"type": "string",
"description": "Creation timestamp to record. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"JobType": {
"type": "string",
"description": "Job type, e.g. Repair."
},
"ClientId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Existing Workiz client id to attach this to."
},
"JobNotes": {
"type": "string",
"description": "Internal job notes."
},
"LastName": {
"type": "string",
"description": "Client last name."
},
"PhoneExt": {
"type": "string",
"description": "Primary phone extension."
},
"Timezone": {
"type": "string",
"description": "Timezone, e.g. US/Pacific."
},
"CreatedBy": {
"type": "string",
"description": "Name recorded as the creator."
},
"FirstName": {
"type": "string",
"description": "Client first name."
},
"JobSource": {
"type": "string",
"description": "Lead/job source, e.g. Google."
},
"PostalCode": {
"type": "string",
"description": "Postal / ZIP code."
},
"JobDateTime": {
"type": "string",
"description": "Scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"SecondPhone": {
"type": "string",
"description": "Secondary phone."
},
"ServiceArea": {
"type": "string",
"description": "Service area, e.g. metro1."
},
"JobEndDateTime": {
"type": "string",
"description": "Scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"SecondPhoneExt": {
"type": "string",
"description": "Secondary phone extension."
},
"ReferralCompany": {
"type": "string",
"description": "Referral company, e.g. Thumbtack."
}
}
}| Job type, e.g. Repair. |
| ClientId | integer | Existing Workiz client id to attach this to. |
| LastName | string | Client last name. |
| PhoneExt | string | Primary phone extension. |
| Timezone | string | Timezone, e.g. US/Pacific. |
| CreatedBy | string | Name recorded as the creator. |
| FirstName | string | Client first name. |
| JobSource | string | Lead/job source, e.g. Google. |
| LeadNotes | string | Internal lead notes. |
| PostalCode | string | Postal / ZIP code. |
| SecondPhone | string | Secondary phone. |
| ServiceArea | string | Service area, e.g. metro1. |
| LeadDateTime | string | Scheduled start of the lead appointment. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| SecondPhoneExt | string | Secondary phone extension. |
| LeadEndDateTime | string | Scheduled end of the lead appointment. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| ReferralCompany | string | Referral company, e.g. Thumbtack. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"City": {
"type": "string",
"description": "City."
},
"Unit": {
"type": "string",
"description": "Unit / apartment."
},
"Email": {
"type": "string",
"description": "Client email."
},
"Phone": {
"type": "string",
"description": "Primary phone, digits only, e.g. 6195555555."
},
"State": {
"type": "string",
"description": "State, e.g. CA."
},
"Address": {
"type": "string",
"description": "Street address, e.g. 123 W Main Street."
},
"Company": {
"type": "string",
"description": "Client company name."
},
"Country": {
"type": "string",
"description": "Country code, e.g. US."
},
"Created": {
"type": "string",
"description": "Creation timestamp to record. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"JobType": {
"type": "string",
"description": "Job type, e.g. Repair."
},
"ClientId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Existing Workiz client id to attach this to."
},
"LastName": {
"type": "string",
"description": "Client last name."
},
"PhoneExt": {
"type": "string",
"description": "Primary phone extension."
},
"Timezone": {
"type": "string",
"description": "Timezone, e.g. US/Pacific."
},
"CreatedBy": {
"type": "string",
"description": "Name recorded as the creator."
},
"FirstName": {
"type": "string",
"description": "Client first name."
},
"JobSource": {
"type": "string",
"description": "Lead/job source, e.g. Google."
},
"LeadNotes": {
"type": "string",
"description": "Internal lead notes."
},
"PostalCode": {
"type": "string",
"description": "Postal / ZIP code."
},
"SecondPhone": {
"type": "string",
"description": "Secondary phone."
},
"ServiceArea": {
"type": "string",
"description": "Service area, e.g. metro1."
},
"LeadDateTime": {
"type": "string",
"description": "Scheduled start of the lead appointment. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"SecondPhoneExt": {
"type": "string",
"description": "Secondary phone extension."
},
"LeadEndDateTime": {
"type": "string",
"description": "Scheduled end of the lead appointment. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"ReferralCompany": {
"type": "string",
"description": "Referral company, e.g. Thumbtack."
}
}
}| Client company name. |
| Country | string | Country code, e.g. US. |
| JobType | string | Job type, e.g. Repair. |
| ClientId | integer | Existing Workiz client id to attach this to. |
| JobNotes | string | Internal job notes. |
| LastName | string | Client last name. |
| PhoneExt | string | Primary phone extension. |
| Timezone | string | Timezone, e.g. US/Pacific. |
| CreatedBy | string | Name recorded as the creator. |
| FirstName | string | Client first name. |
| JobSource | string | Lead/job source, e.g. Google. |
| SubStatus | string | New job sub-status. |
| PostalCode | string | Postal / ZIP code. |
| JobDateTime | string | New scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| SecondPhone | string | Secondary phone. |
| ServiceArea | string | Service area, e.g. metro1. |
| JobEndDateTime | string | New scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| SecondPhoneExt | string | Secondary phone extension. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"UUID"
],
"properties": {
"City": {
"type": "string",
"description": "City."
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job tags, e.g. [\"estimate\", \"callback\"]."
},
"UUID": {
"type": "string",
"minLength": 1,
"description": "The job's UUID (e.g. XYZ56X)."
},
"Unit": {
"type": "string",
"description": "Unit / apartment."
},
"Email": {
"type": "string",
"description": "Client email."
},
"Phone": {
"type": "string",
"description": "Primary phone, digits only, e.g. 6195555555."
},
"State": {
"type": "string",
"description": "State, e.g. CA."
},
"Status": {
"type": "string",
"description": "New job status, e.g. \"In progress\"."
},
"Address": {
"type": "string",
"description": "Street address, e.g. 123 W Main Street."
},
"Company": {
"type": "string",
"description": "Client company name."
},
"Country": {
"type": "string",
"description": "Country code, e.g. US."
},
"JobType": {
"type": "string",
"description": "Job type, e.g. Repair."
},
"ClientId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Existing Workiz client id to attach this to."
},
"JobNotes": {
"type": "string",
"description": "Internal job notes."
},
"LastName": {
"type": "string",
"description": "Client last name."
},
"PhoneExt": {
"type": "string",
"description": "Primary phone extension."
},
"Timezone": {
"type": "string",
"description": "Timezone, e.g. US/Pacific."
},
"CreatedBy": {
"type": "string",
"description": "Name recorded as the creator."
},
"FirstName": {
"type": "string",
"description": "Client first name."
},
"JobSource": {
"type": "string",
"description": "Lead/job source, e.g. Google."
},
"SubStatus": {
"type": "string",
"description": "New job sub-status."
},
"PostalCode": {
"type": "string",
"description": "Postal / ZIP code."
},
"JobDateTime": {
"type": "string",
"description": "New scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"SecondPhone": {
"type": "string",
"description": "Secondary phone."
},
"ServiceArea": {
"type": "string",
"description": "Service area, e.g. metro1."
},
"JobEndDateTime": {
"type": "string",
"description": "New scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"SecondPhoneExt": {
"type": "string",
"description": "Secondary phone extension."
}
}
}| Client company name. |
| Country | string | Country code, e.g. US. |
| JobType | string | Job type, e.g. Repair. |
| ClientId | integer | Existing Workiz client id to attach this to. |
| LastName | string | Client last name. |
| PhoneExt | string | Primary phone extension. |
| Timezone | string | Timezone, e.g. US/Pacific. |
| CreatedBy | string | Name recorded as the creator. |
| FirstName | string | Client first name. |
| JobSource | string | Lead/job source, e.g. Google. |
| LeadNotes | string | Internal lead notes. |
| PostalCode | string | Postal / ZIP code. |
| SecondPhone | string | Secondary phone. |
| ServiceArea | string | Service area, e.g. metro1. |
| LeadDateTime | string | New scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
| SecondPhoneExt | string | Secondary phone extension. |
| LeadEndDateTime | string | New scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"UUID"
],
"properties": {
"City": {
"type": "string",
"description": "City."
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lead tags, e.g. [\"estimate\", \"callback\"]."
},
"UUID": {
"type": "string",
"minLength": 1,
"description": "The lead's UUID (e.g. XYZ56X)."
},
"Unit": {
"type": "string",
"description": "Unit / apartment."
},
"Email": {
"type": "string",
"description": "Client email."
},
"Phone": {
"type": "string",
"description": "Primary phone, digits only, e.g. 6195555555."
},
"State": {
"type": "string",
"description": "State, e.g. CA."
},
"Status": {
"type": "string",
"description": "New lead status, e.g. \"In progress\"."
},
"Address": {
"type": "string",
"description": "Street address, e.g. 123 W Main Street."
},
"Company": {
"type": "string",
"description": "Client company name."
},
"Country": {
"type": "string",
"description": "Country code, e.g. US."
},
"JobType": {
"type": "string",
"description": "Job type, e.g. Repair."
},
"ClientId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Existing Workiz client id to attach this to."
},
"LastName": {
"type": "string",
"description": "Client last name."
},
"PhoneExt": {
"type": "string",
"description": "Primary phone extension."
},
"Timezone": {
"type": "string",
"description": "Timezone, e.g. US/Pacific."
},
"CreatedBy": {
"type": "string",
"description": "Name recorded as the creator."
},
"FirstName": {
"type": "string",
"description": "Client first name."
},
"JobSource": {
"type": "string",
"description": "Lead/job source, e.g. Google."
},
"LeadNotes": {
"type": "string",
"description": "Internal lead notes."
},
"PostalCode": {
"type": "string",
"description": "Postal / ZIP code."
},
"SecondPhone": {
"type": "string",
"description": "Secondary phone."
},
"ServiceArea": {
"type": "string",
"description": "Service area, e.g. metro1."
},
"LeadDateTime": {
"type": "string",
"description": "New scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
},
"SecondPhoneExt": {
"type": "string",
"description": "Secondary phone extension."
},
"LeadEndDateTime": {
"type": "string",
"description": "New scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z."
}
}
}