API_KEY
workiz_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Workiz API Keygeneric_api_key · stringRequired
All integrations
WO
Catalogue metadata onlycrmv00000000_00
WORKIZ
Workiz
Workiz is a field service management platform for scheduling jobs, managing leads and teams, and recording payments.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
No Pakkawork execution adapter is enabled. Hosted account-authorisation availability is workspace-specific and checked separately in the dashboard.Check workspace connection options
Attributed source 21
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
What setup is declared?
Only field names, types, and required markers are shown. Secret values, default auth URLs, credential material, and inferred OAuth scopes are excluded.
API_KEY
Provider setup
Capability index
Actions and trigger definitions
Static summaries are available. Live schemas remain disabled until PROVIDER_HUB_API_KEY is configured server-side.
Showing 1–21 of 21 actions
Add Client Note
WORKIZ_ADD_CLIENT_NOTE
Add a text note to a Workiz client and optionally pin it.
Untrusted display-only summary
Assign Technician
WORKIZ_ASSIGN_TECHNICIAN
Assign a technician to a Workiz job or lead, optionally replacing the existing technician when the account disallows multiple technicians.
Untrusted display-only summary
Assign Technicians
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.
Untrusted display-only summary
Convert Lead to Job
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.
Untrusted display-only summary
Create Job
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.
Untrusted display-only summary
Create Lead
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.
Untrusted display-only summary
Get Client
WORKIZ_GET_CLIENT
Retrieve one Workiz client with service and billing addresses, contacts, tags, notes, custom fields, and other detail fields.
Untrusted display-only summary
Get Invoice or Estimate
WORKIZ_GET_FINANCIAL_DOCUMENT
Retrieve one Workiz invoice or estimate with line items, payments, client and job links, totals, and status.
Untrusted display-only summary
Get Job or Lead
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.
Untrusted display-only summary
List Assigned Technicians
WORKIZ_LIST_ASSIGNED_TECHNICIANS
List one page of technicians assigned to a Workiz job or lead.
Untrusted display-only summary
List Client Notes
WORKIZ_LIST_CLIENT_NOTES
List one page of notes recorded on a Workiz client, ordered by creation date descending.
Untrusted display-only summary
List Clients
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.
Untrusted display-only summary
List Invoices or Estimates
WORKIZ_LIST_FINANCIAL_DOCUMENTS
List Workiz invoices or estimates with optional created or updated date filtering. Returns one page and a continuation cursor.
Untrusted display-only summary
List Jobs or Leads
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.
Untrusted display-only summary
List Workiz Reference Data
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.
Untrusted display-only summary
List Users
WORKIZ_LIST_USERS
List Workiz users and technicians for assignment and attribution workflows. Returns one page and a cursor for controlled continuation.
Untrusted display-only summary
Remove Technician
WORKIZ_REMOVE_TECHNICIAN
Remove a technician assignment from a Workiz job or lead.
Untrusted display-only summary
Search Workiz Records
WORKIZ_SEARCH_RECORDS
Search jobs, leads, clients, and invoices by a name, phone, email, address, serial number, or custom-field value.
Untrusted display-only summary
Set Primary Technician
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.
Untrusted display-only summary
Update Job
WORKIZ_UPDATE_JOB
Update only the selected fields of an existing Workiz job. Unspecified fields remain unchanged.
Untrusted display-only summary
Update Lead
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.
Untrusted display-only summary
Provenance
Versioned facts, explicit trust.
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
- Repository
- https://github.com/provider-directoryHQ/provider-directory
- Commit
- 85e33f6a81dfe987f6fc3637d48d45052cea8ca5
- Generated
- 2026-09-12
- Trust policy
- untrusted_display_only
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.