> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Workiz

> Workiz is a field service management platform for scheduling jobs, managing leads and teams, and recording payments.

![Workiz logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/workiz.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=28b921fcf9e80dd6a251f13e284ad34e)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 21
* **Triggers:** 0
* **Slug:** `WORKIZ`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Client Note
>
> **Slug:** `WORKIZ_ADD_CLIENT_NOTE`
>
> Add a text note to a Workiz client and optionally pin it.
>
> #### Input Parameters
>
> **pin** `boolean`
>
> Pin the note for prominence.
>
> **note** `string` *required*
>
> Note text to append to the client record.
>
> **client\_id** `string` *required*
>
> Workiz client ID beginning with CL-.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Technician
>
> **Slug:** `WORKIZ_ASSIGN_TECHNICIAN`
>
> Assign a technician to a Workiz job or lead, optionally replacing the existing technician when the account disallows multiple technicians.
>
> #### Input Parameters
>
> **replace** `boolean`
>
> Replace the existing technician. Set true when multiple technicians are disabled or replacement is intended.
>
> **record\_id** `string` *required*
>
> Workiz JOB- or LD- ID matching record\_type.
>
> **is\_primary** `boolean`
>
> Make this technician the primary assignment.
>
> **record\_type** `string ("job" | "lead")` *required*
>
> Kind of Workiz record to assign: job or lead.
>
> **technician\_id** `string` *required*
>
> Workiz user ID beginning with USR-.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Technicians
>
> **Slug:** `WORKIZ_ASSIGN_TECHNICIANS`
>
> Assign up to 25 technicians to one Workiz job or lead on a multi-technician account and return a separate success or failure result for each technician.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Workiz JOB- or LD- ID matching record\_type.
>
> **assignments** `array` *required*
>
> Unique technicians to assign, in request order. Use only on accounts that allow multiple technicians. At most one assignment may be primary.
>
> **record\_type** `string ("job" | "lead")` *required*
>
> Kind of Workiz record to assign: job or lead.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Lead to Job
>
> **Slug:** `WORKIZ_CONVERT_LEAD_TO_JOB`
>
> Irreversibly convert an existing Workiz lead into a job and return the resulting job. This operational transition cannot be undone and creates a persistent job record. Never use this action merely to inspect a lead.
>
> #### Input Parameters
>
> **lead\_id** `string` *required*
>
> Workiz lead ID beginning with LD- to irreversibly convert into a job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job
>
> **Slug:** `WORKIZ_CREATE_JOB`
>
> Create a scheduled or unscheduled Workiz job for an existing client, or match or create an inline client and create the job for them.
>
> #### Input Parameters
>
> **end** `string`
>
> Scheduled end in YYYY-MM-DD HH:MM:SS format, after start.
>
> **name** `string`
>
> Agent-readable job name, limited by Workiz to 20 characters.
>
> **start** `string`
>
> Scheduled start in YYYY-MM-DD HH:MM:SS format. Workiz rounds schedule times to a quarter hour.
>
> **time\_zone** `string`
>
> IANA timezone for the job.
>
> **is\_all\_day** `boolean`
>
> Whether the scheduled job occupies the full day.
>
> **ad\_group\_id** `string`
>
> Ad group ID beginning with AG-.
>
> **client\_info** `object` *required*
>
> Existing-client selector or complete details for matching or creating a client.
>
> **description** `string`
>
> Work description and relevant context.
>
> **job\_type\_id** `string` *required*
>
> Job type ID beginning with JT-. Use LIST\_REFERENCE\_DATA to discover it.
>
> **is\_scheduled** `boolean`
>
> Whether to schedule the job. start and end are required when true.
>
> **custom\_fields** `array`
>
> Custom-field IDs and their string, numeric, or boolean values.
>
> **created\_by\_user\_id** `string`
>
> Workiz user ID beginning with USR- to attribute as the creator.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Lead
>
> **Slug:** `WORKIZ_CREATE_LEAD`
>
> Create a scheduled or unscheduled Workiz lead for an existing client, or match or create an inline client and create the lead for them.
>
> #### Input Parameters
>
> **end** `string`
>
> Scheduled end in YYYY-MM-DD HH:MM:SS format, after start.
>
> **start** `string`
>
> Scheduled start in YYYY-MM-DD HH:MM:SS format. Workiz rounds schedule times to a quarter hour.
>
> **time\_zone** `string`
>
> IANA timezone for the lead.
>
> **is\_all\_day** `boolean`
>
> Whether the scheduled lead occupies the full day.
>
> **ad\_group\_id** `string`
>
> Ad group ID beginning with AG-.
>
> **client\_info** `object` *required*
>
> Existing-client selector or details for matching or creating a client.
>
> **description** `string`
>
> Lead request and relevant context.
>
> **job\_type\_id** `string`
>
> Job type ID beginning with JT-.
>
> **is\_scheduled** `boolean`
>
> Whether to schedule the lead. start and end are required when true.
>
> **custom\_fields** `array`
>
> Custom-field IDs and their string, numeric, or boolean values.
>
> **created\_by\_user\_id** `string`
>
> Workiz user ID beginning with USR- to attribute as the creator.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Client
>
> **Slug:** `WORKIZ_GET_CLIENT`
>
> Retrieve one Workiz client with service and billing addresses, contacts, tags, notes, custom fields, and other detail fields.
>
> #### Input Parameters
>
> **client\_id** `string` *required*
>
> Workiz client ID beginning with CL-.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Invoice or Estimate
>
> **Slug:** `WORKIZ_GET_FINANCIAL_DOCUMENT`
>
> Retrieve one Workiz invoice or estimate with line items, payments, client and job links, totals, and status.
>
> #### Input Parameters
>
> **document\_id** `string` *required*
>
> Workiz document ID matching document\_type: IV- for an invoice or ES- for an estimate.
>
> **document\_type** `string ("invoice" | "estimate")` *required*
>
> Financial document family to retrieve: invoice or estimate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job or Lead
>
> **Slug:** `WORKIZ_GET_JOB_OR_LEAD`
>
> Retrieve one Workiz job or lead, selected by record\_type, including its client, schedule, status, and resource-specific detail fields.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Workiz JOB- or LD- ID matching record\_type.
>
> **record\_type** `string ("job" | "lead")` *required*
>
> Kind of Workiz record to retrieve: job or lead.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Assigned Technicians
>
> **Slug:** `WORKIZ_LIST_ASSIGNED_TECHNICIANS`
>
> List one page of technicians assigned to a Workiz job or lead.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum technician assignments to return in this page (1-300).
>
> **record\_id** `string` *required*
>
> Workiz JOB- or LD- ID matching record\_type.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response. Repeat the same record\_type and record\_id when continuing.
>
> **record\_type** `string ("job" | "lead")` *required*
>
> Kind of Workiz record whose assigned technicians to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Notes
>
> **Slug:** `WORKIZ_LIST_CLIENT_NOTES`
>
> List one page of notes recorded on a Workiz client, ordered by creation date descending.
>
> #### Input Parameters
>
> **client\_id** `string` *required*
>
> Workiz client ID beginning with CL-.
>
> **page\_size** `integer`
>
> Maximum client notes to return in this page (1-300).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response for the same client; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Clients
>
> **Slug:** `WORKIZ_LIST_CLIENTS`
>
> List and search Workiz clients with balance, tag, created-date, and sort filters. Returns one page and a cursor for controlled continuation.
>
> #### Input Parameters
>
> **date** `string`
>
> Created date as YYYY-MM-DD, or two underscore-separated dates (YYYY-MM-DD\_YYYY-MM-DD) when date\_operator is between.
>
> **tag\_ids** `array`
>
> Workiz tag IDs beginning with TAG-. A client must have every listed tag.
>
> **page\_size** `integer`
>
> Maximum clients to return in this page (1-300).
>
> **sort\_field** `string ("serialId" | "firstName" | "fullName" | "clientCompany" | "primaryPhone")`
>
> Client field to sort by. Workiz defaults to serialId when omitted.
>
> **sort\_order** `string ("ASC" | "DESC")`
>
> Sort direction. Defaults to descending.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response using the same filters; omit for the first page.
>
> **search\_query** `string`
>
> Match client name, company, address, custom fields, primary phone, or email.
>
> **date\_operator** `string ("prev" | "next" | "between")`
>
> Created-date comparison. Must be provided together with date.
>
> **balance\_status** `string ("PastDue" | "Due")`
>
> Filter by outstanding balance: Due includes any open balance; PastDue includes overdue balances.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Invoices or Estimates
>
> **Slug:** `WORKIZ_LIST_FINANCIAL_DOCUMENTS`
>
> List Workiz invoices or estimates with optional created or updated date filtering. Returns one page and a continuation cursor.
>
> #### Input Parameters
>
> **date** `string`
>
> Date as YYYY-MM-DD for prev or next, or two dates separated by an underscore (YYYY-MM-DD\_YYYY-MM-DD) for between.
>
> **page\_size** `integer`
>
> Maximum documents to return in this page (1-300).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response for the same document type and filters; omit for the first page.
>
> **date\_operator** `string ("prev" | "next" | "between")`
>
> Date comparison. Provide with date\_property and date.
>
> **date\_property** `string ("updated" | "created")`
>
> Document date field to filter. Provide with date\_operator and date.
>
> **document\_type** `string ("invoice" | "estimate")` *required*
>
> Financial document family to list: invoice or estimate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Jobs or Leads
>
> **Slug:** `WORKIZ_LIST_JOBS_OR_LEADS`
>
> List one page of Workiz jobs or leads, selected by record\_type, with optional open-state, date, and sort filters, and return a continuation cursor.
>
> #### Input Parameters
>
> **date** `string`
>
> Date as YYYY-MM-DD, or two dates separated by an underscore (YYYY-MM-DD\_YYYY-MM-DD) when date\_operator is between.
>
> **is\_open** `boolean`
>
> When true, return only open records; omit to avoid applying Workiz's false default.
>
> **page\_size** `integer`
>
> Maximum records to return in this page (1-300).
>
> **sort\_field** `string ("created" | "updated" | "statusUpdated" | "utcUpdated")`
>
> Field to sort by. Must be provided together with sort\_order.
>
> **sort\_order** `string ("ASC" | "DESC")`
>
> Sort direction. Must be provided together with sort\_field.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response for the same record\_type, filters, and page\_size; omit for the first page.
>
> **record\_type** `string ("job" | "lead")` *required*
>
> Kind of Workiz records to list: jobs or leads.
>
> **date\_operator** `string ("prev" | "next" | "between")`
>
> Date comparison. Must be provided with date\_property and date.
>
> **date\_property** `string ("date" | "endDate" | "utcUpdated" | "created")`
>
> Record date field to filter. Must be provided with date\_operator and date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workiz Reference Data
>
> **Slug:** `WORKIZ_LIST_REFERENCE_DATA`
>
> List IDs and names needed to create or update Workiz records, such as job types, ad groups, tags, statuses, and custom fields.
>
> #### Input Parameters
>
> **tag\_type** `string ("job" | "client" | "call" | "task" | "project")`
>
> Tag family to return. Valid only when resource\_type is tag.
>
> **page\_size** `integer`
>
> Records to return for paginated reference types (1-300).
>
> **entity\_type** `string ("JOB" | "CLIENT")`
>
> Entity whose custom fields or custom-field groups to return. Valid only for those resource types.
>
> **next\_cursor** `string`
>
> Continuation cursor from a prior call for the same resource type and filters. Omit for the first page.
>
> **resource\_type** `string ("job_type" | "ad_group" | "tag" | "job_sub_status" | "lead_status" | "custom_field" | "custom_field_group")` *required*
>
> Reference-data family to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `WORKIZ_LIST_USERS`
>
> List Workiz users and technicians for assignment and attribution workflows. Returns one page and a cursor for controlled continuation.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum users to return in this page (1-300).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Technician
>
> **Slug:** `WORKIZ_REMOVE_TECHNICIAN`
>
> Remove a technician assignment from a Workiz job or lead. The result reports an already-absent assignment if either the record or assignment was not found.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Workiz JOB- or LD- ID matching record\_type.
>
> **record\_type** `string ("job" | "lead")` *required*
>
> Kind of Workiz record containing the technician assignment.
>
> **technician\_id** `string` *required*
>
> Assigned Workiz user ID beginning with USR-.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Workiz Records
>
> **Slug:** `WORKIZ_SEARCH_RECORDS`
>
> Search jobs, leads, clients, and invoices by a name, phone, email, address, serial number, or custom-field value.
>
> #### Input Parameters
>
> **term** `string` *required*
>
> Search term matched across supported Workiz record fields.
>
> **limit** `integer`
>
> Maximum results per record type (1-15).
>
> **record\_type** `string ("job" | "lead" | "client" | "invoice")`
>
> Restrict results to one record type; omit to search all supported types.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Primary Technician
>
> **Slug:** `WORKIZ_SET_PRIMARY_TECHNICIAN`
>
> Make an already assigned technician the primary technician on a Workiz job or lead. All other assigned technicians become non-primary.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Workiz JOB- or LD- ID matching record\_type.
>
> **record\_type** `string ("job" | "lead")` *required*
>
> Kind of Workiz record containing the technician assignment.
>
> **technician\_id** `string` *required*
>
> Already assigned Workiz user ID beginning with USR-.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job
>
> **Slug:** `WORKIZ_UPDATE_JOB`
>
> Update only the selected fields of an existing Workiz job. Unspecified fields remain unchanged.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> Workiz job ID beginning with JOB-.
>
> **changes** `object` *required*
>
> Selected job fields to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Lead
>
> **Slug:** `WORKIZ_UPDATE_LEAD`
>
> Update only selected fields of an existing Workiz lead, including status, schedule, client details, tags, and custom fields. Unspecified fields remain unchanged.
>
> #### Input Parameters
>
> **changes** `object` *required*
>
> Selected lead fields to update.
>
> **lead\_id** `string` *required*
>
> Workiz lead ID beginning with LD-.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
