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

Users - technicians, dispatchers, and office staff.

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

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

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

2 operations 2 paths 4 schemas 2 GET

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 2

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

Team 2

Users - technicians, dispatchers, and office staff.

GET
/team/all/
List team members
listTeam → 200401
GET
/team/get/{USER_ID}/
Get a team member
getTeamMember 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TeamMember (5 properties), Error (3 properties), TeamListResponse (2 properties), TeamMemberResponse (2 properties). Each schema is shown below with its type and property counts.

TeamMemberResponse
object
2 properties
TeamListResponse
object
2 properties
TeamMember
object
5 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workiz-team-api-openapi.yml Raw ↑

Other APIs Workiz publishes across the network.

Workiz Jobs API
Workiz Leads API
Workiz Payments API
Workiz Time Off API