Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workiz Jobs API

Work orders - the core scheduling and dispatch entity in Workiz.

Workiz Jobs API is one of 5 APIs that Workiz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.workiz.com/api/v1/{api_token}.

6 operations 6 paths 9 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.workiz.com/api/v1
Contact
Resource Areas
1

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 6

Work orders - the core scheduling and dispatch entity in Workiz.

GET
/job/all/
List jobs
listJobs 5 params → 200401
GET
/job/get/{UUID}/
Get a job
getJob 1 param → 200401404
POST
/job/create/
Create a job
createJob body → 200401
POST
/job/update/
Update a job
updateJob body → 200401404
POST
/job/assign/
Assign a user to a job
assignJob body → 200401
POST
/job/unassign/
Unassign a user from a job
unassignJob body → 200401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Job (24 properties), JobInput (14 properties), LineItem (4 properties), JobListResponse (3 properties). Each schema is shown below with its type and property counts.

LineItem
object
4 properties
JobResponse
object
2 properties
JobUpdateInput
JobListResponse
object
3 properties
Job
object
A Workiz job (work order).
24 properties
JobAssignmentInput
object
2 properties 2 required
JobInput
object
14 properties 2 required
Error
object
3 properties
GenericResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workiz-jobs-api-openapi.yml Raw ↑

Other APIs Workiz publishes across the network.

Workiz Leads API
Workiz Payments API
Workiz Team API
Workiz Time Off API