Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Workiz Team API
description: The Workiz REST API lets home-service businesses read and write their field service data - jobs, leads, team members, time off, and payments - and receive outbound webhooks for new jobs and new leads.
version: '1.0'
contact:
name: Workiz
url: https://developer.workiz.com/
servers:
- url: https://api.workiz.com/api/v1/{api_token}
description: Workiz REST API. The account API token is part of the base path.
variables:
api_token:
default: YOUR_API_TOKEN
description: The account API token from the Workiz Developer API add-on (Settings > Integrations). It is placed directly in the URL path; there is no Authorization header. A paired API secret is issued for signed requests where required.
tags:
- name: Team
description: Users - technicians, dispatchers, and office staff.
paths:
/team/all/:
get:
operationId: listTeam
tags:
- Team
summary: List team members
description: Returns all team members (technicians, dispatchers, office users) in the account.
x-endpoint-status: confirmed
responses:
'200':
description: A list of team members.
content:
application/json:
schema:
$ref: '#/components/schemas/TeamListResponse'
'401':
$ref: '#/components/responses/Unauthorized'
/team/get/{USER_ID}/:
parameters:
- name: USER_ID
in: path
required: true
description: The user ID of the team member.
schema:
type: string
get:
operationId: getTeamMember
tags:
- Team
summary: Get a team member
description: Retrieves a single team member by user ID.
x-endpoint-status: confirmed
responses:
'200':
description: The requested team member.
content:
application/json:
schema:
$ref: '#/components/schemas/TeamMemberResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
Error:
type: object
properties:
flag:
type: boolean
description: Workiz success flag; false on error.
code:
type: integer
data:
type: string
description: Human-readable error message.
TeamListResponse:
type: object
properties:
flag:
type: boolean
data:
type: array
items:
$ref: '#/components/schemas/TeamMember'
TeamMember:
type: object
properties:
id:
type: string
name:
type: string
email:
type: string
role:
type: string
active:
type: boolean
TeamMemberResponse:
type: object
properties:
flag:
type: boolean
data:
$ref: '#/components/schemas/TeamMember'
responses:
Unauthorized:
description: Missing or invalid API token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The requested resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'