Workiz API Documentation

This is the complete API documentation for connecting to the Workiz API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Workiz: Schedule jobs, dispatch teams, invoice customers, and manage leads. Keep reading to get started.

Quickstart

Before you run your first Workiz request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Workiz connection — create or choose one in Connections. Note its connectionId.

Every Workiz action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/workiz/actions/{actionSlug}/run

You need a MindCloud API Key and a Workiz connection. Then call an action such as List Team Members:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/workiz/actions/list-team-members/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Workiz account. See Workiz API Authentication for the full flow and how to get your connection credentials.

Workiz actions

All 20 published actions for this Workiz version. Each page documents the endpoint, arguments, and response controls.

• PUTActivate Lead
• PUTAdd Job Payment
• PUTAssign User to Job
• PUTAssign User to Lead
• PUTConvert Lead To Job
• POSTCreate Job
• POSTCreate Lead
• GETGet Job
• GETGet Lead
• GETGet Team Member
• GETList Jobs
• GETList Leads
• GETList Team Members
• GETList Time Offs
• GETList Time Offs by User
• PUTMark Lead Lost
• PUTUnassign User from Job
• PUTUnassign User from Lead
• PUTUpdate Job
• PUTUpdate Lead

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear