Skip to main content
Workiz logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: WORKIZ
  • Version: 20261101_00

Tools

Slug: WORKIZ_ADD_CLIENT_NOTEAdd a text note to a Workiz client and optionally pin it.

Input Parameters

boolean
Pin the note for prominence.
string
required
Note text to append to the client record.
string
required
Workiz client ID beginning with CL-.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_ASSIGN_TECHNICIANAssign a technician to a Workiz job or lead, optionally replacing the existing technician when the account disallows multiple technicians.

Input Parameters

boolean
Replace the existing technician. Set true when multiple technicians are disabled or replacement is intended.
string
required
Workiz JOB- or LD- ID matching record_type.
boolean
Make this technician the primary assignment.
string ("job" | "lead")
required
Kind of Workiz record to assign: job or lead.
string
required
Workiz user ID beginning with USR-.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_ASSIGN_TECHNICIANSAssign 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

string
required
Workiz JOB- or LD- ID matching record_type.
array
required
Unique technicians to assign, in request order. Use only on accounts that allow multiple technicians. At most one assignment may be primary.
string ("job" | "lead")
required
Kind of Workiz record to assign: job or lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_CONVERT_LEAD_TO_JOBIrreversibly 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

string
required
Workiz lead ID beginning with LD- to irreversibly convert into a job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_CREATE_JOBCreate 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

string
Scheduled end in YYYY-MM-DD HH:MM:SS format, after start.
string
Agent-readable job name, limited by Workiz to 20 characters.
string
Scheduled start in YYYY-MM-DD HH:MM:SS format. Workiz rounds schedule times to a quarter hour.
string
IANA timezone for the job.
boolean
Whether the scheduled job occupies the full day.
string
Ad group ID beginning with AG-.
object
required
Existing-client selector or complete details for matching or creating a client.
string
Work description and relevant context.
string
required
Job type ID beginning with JT-. Use LIST_REFERENCE_DATA to discover it.
boolean
Whether to schedule the job. start and end are required when true.
array
Custom-field IDs and their string, numeric, or boolean values.
string
Workiz user ID beginning with USR- to attribute as the creator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_CREATE_LEADCreate 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

string
Scheduled end in YYYY-MM-DD HH:MM:SS format, after start.
string
Scheduled start in YYYY-MM-DD HH:MM:SS format. Workiz rounds schedule times to a quarter hour.
string
IANA timezone for the lead.
boolean
Whether the scheduled lead occupies the full day.
string
Ad group ID beginning with AG-.
object
required
Existing-client selector or details for matching or creating a client.
string
Lead request and relevant context.
string
Job type ID beginning with JT-.
boolean
Whether to schedule the lead. start and end are required when true.
array
Custom-field IDs and their string, numeric, or boolean values.
string
Workiz user ID beginning with USR- to attribute as the creator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_GET_CLIENTRetrieve one Workiz client with service and billing addresses, contacts, tags, notes, custom fields, and other detail fields.

Input Parameters

string
required
Workiz client ID beginning with CL-.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_GET_FINANCIAL_DOCUMENTRetrieve one Workiz invoice or estimate with line items, payments, client and job links, totals, and status.

Input Parameters

string
required
Workiz document ID matching document_type: IV- for an invoice or ES- for an estimate.
string ("invoice" | "estimate")
required
Financial document family to retrieve: invoice or estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_GET_JOB_OR_LEADRetrieve one Workiz job or lead, selected by record_type, including its client, schedule, status, and resource-specific detail fields.

Input Parameters

string
required
Workiz JOB- or LD- ID matching record_type.
string ("job" | "lead")
required
Kind of Workiz record to retrieve: job or lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_LIST_ASSIGNED_TECHNICIANSList one page of technicians assigned to a Workiz job or lead.

Input Parameters

integer
Maximum technician assignments to return in this page (1-300).
string
required
Workiz JOB- or LD- ID matching record_type.
string
Continuation cursor from a previous response. Repeat the same record_type and record_id when continuing.
string ("job" | "lead")
required
Kind of Workiz record whose assigned technicians to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_LIST_CLIENT_NOTESList one page of notes recorded on a Workiz client, ordered by creation date descending.

Input Parameters

string
required
Workiz client ID beginning with CL-.
integer
Maximum client notes to return in this page (1-300).
string
Continuation cursor from a previous response for the same client; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_LIST_CLIENTSList and search Workiz clients with balance, tag, created-date, and sort filters. Returns one page and a cursor for controlled continuation.

Input Parameters

string
Created date as YYYY-MM-DD, or two underscore-separated dates (YYYY-MM-DD_YYYY-MM-DD) when date_operator is between.
array
Workiz tag IDs beginning with TAG-. A client must have every listed tag.
integer
Maximum clients to return in this page (1-300).
string ("serialId" | "firstName" | "fullName" | "clientCompany" | "primaryPhone")
Client field to sort by. Workiz defaults to serialId when omitted.
string ("ASC" | "DESC")
Sort direction. Defaults to descending.
string
Continuation cursor from a previous response using the same filters; omit for the first page.
string
Match client name, company, address, custom fields, primary phone, or email.
string ("prev" | "next" | "between")
Created-date comparison. Must be provided together with date.
string ("PastDue" | "Due")
Filter by outstanding balance: Due includes any open balance; PastDue includes overdue balances.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_LIST_FINANCIAL_DOCUMENTSList Workiz invoices or estimates with optional created or updated date filtering. Returns one page and a continuation cursor.

Input Parameters

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.
integer
Maximum documents to return in this page (1-300).
string
Continuation cursor from a previous response for the same document type and filters; omit for the first page.
string ("prev" | "next" | "between")
Date comparison. Provide with date_property and date.
string ("updated" | "created")
Document date field to filter. Provide with date_operator and date.
string ("invoice" | "estimate")
required
Financial document family to list: invoice or estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_LIST_JOBS_OR_LEADSList 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

string
Date as YYYY-MM-DD, or two dates separated by an underscore (YYYY-MM-DD_YYYY-MM-DD) when date_operator is between.
boolean
When true, return only open records; omit to avoid applying Workiz’s false default.
integer
Maximum records to return in this page (1-300).
string ("created" | "updated" | "statusUpdated" | "utcUpdated")
Field to sort by. Must be provided together with sort_order.
string ("ASC" | "DESC")
Sort direction. Must be provided together with sort_field.
string
Continuation cursor from a previous response for the same record_type, filters, and page_size; omit for the first page.
string ("job" | "lead")
required
Kind of Workiz records to list: jobs or leads.
string ("prev" | "next" | "between")
Date comparison. Must be provided with date_property and date.
string ("date" | "endDate" | "utcUpdated" | "created")
Record date field to filter. Must be provided with date_operator and date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_LIST_REFERENCE_DATAList IDs and names needed to create or update Workiz records, such as job types, ad groups, tags, statuses, and custom fields.

Input Parameters

string ("job" | "client" | "call" | "task" | "project")
Tag family to return. Valid only when resource_type is tag.
integer
Records to return for paginated reference types (1-300).
string ("JOB" | "CLIENT")
Entity whose custom fields or custom-field groups to return. Valid only for those resource types.
string
Continuation cursor from a prior call for the same resource type and filters. Omit for the first page.
string ("job_type" | "ad_group" | "tag" | "job_sub_status" | "lead_status" | "custom_field" | "custom_field_group")
required
Reference-data family to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_LIST_USERSList Workiz users and technicians for assignment and attribution workflows. Returns one page and a cursor for controlled continuation.

Input Parameters

integer
Maximum users to return in this page (1-300).
string
Continuation cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_REMOVE_TECHNICIANRemove 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

string
required
Workiz JOB- or LD- ID matching record_type.
string ("job" | "lead")
required
Kind of Workiz record containing the technician assignment.
string
required
Assigned Workiz user ID beginning with USR-.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_SEARCH_RECORDSSearch jobs, leads, clients, and invoices by a name, phone, email, address, serial number, or custom-field value.

Input Parameters

string
required
Search term matched across supported Workiz record fields.
integer
Maximum results per record type (1-15).
string ("job" | "lead" | "client" | "invoice")
Restrict results to one record type; omit to search all supported types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_SET_PRIMARY_TECHNICIANMake an already assigned technician the primary technician on a Workiz job or lead. All other assigned technicians become non-primary.

Input Parameters

string
required
Workiz JOB- or LD- ID matching record_type.
string ("job" | "lead")
required
Kind of Workiz record containing the technician assignment.
string
required
Already assigned Workiz user ID beginning with USR-.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_UPDATE_JOBUpdate only the selected fields of an existing Workiz job. Unspecified fields remain unchanged.

Input Parameters

string
required
Workiz job ID beginning with JOB-.
object
required
Selected job fields to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKIZ_UPDATE_LEADUpdate only selected fields of an existing Workiz lead, including status, schedule, client details, tags, and custom fields. Unspecified fields remain unchanged.

Input Parameters

object
required
Selected lead fields to update.
string
required
Workiz lead ID beginning with LD-.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not