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 Leads API

Prospective work that can be converted into jobs.

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

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

This API exposes 4 operations across 4 paths, and defines 6 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}.

4 operations 4 paths 6 schemas 2 GET2 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 4

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

Leads 4

Prospective work that can be converted into jobs.

GET
/lead/all/
List leads
listLeads 2 params → 200401
GET
/lead/get/{UUID}/
Get a lead
getLead 1 param → 200401404
POST
/lead/create/
Create a lead
createLead body → 200401
POST
/lead/update/
Update a lead
updateLead body → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Lead (14 properties), LeadInput (11 properties), Error (3 properties), LeadListResponse (3 properties). Each schema is shown below with its type and property counts.

LeadUpdateInput
Lead
object
A Workiz lead (prospective work).
14 properties
LeadListResponse
object
3 properties
Error
object
3 properties
LeadInput
object
11 properties 1 required
LeadResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workiz-leads-api-openapi.yml Raw ↑

Other APIs Workiz publishes across the network.

Workiz Jobs API
Workiz Payments API
Workiz Team API
Workiz Time Off API