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 Time Off 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: Time Off
description: Technician time-off records that affect availability.
paths:
/timeoff/get/:
get:
operationId: listTimeOff
tags:
- Time Off
summary: List time off
description: Returns time-off records for the account.
x-endpoint-status: confirmed
responses:
'200':
description: A list of time-off records.
content:
application/json:
schema:
$ref: '#/components/schemas/TimeOffListResponse'
'401':
$ref: '#/components/responses/Unauthorized'
/timeoff/get/{USER_NAME}/:
parameters:
- name: USER_NAME
in: path
required: true
description: The user name whose time off to retrieve.
schema:
type: string
get:
operationId: getUserTimeOff
tags:
- Time Off
summary: Get time off for a user
description: Returns the time-off records for a specific user by name.
x-endpoint-status: confirmed
responses:
'200':
description: The user's time-off records.
content:
application/json:
schema:
$ref: '#/components/schemas/TimeOffListResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
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'
schemas:
TimeOff:
type: object
properties:
id:
type: string
user:
type: string
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
reason:
type: string
TimeOffListResponse:
type: object
properties:
flag:
type: boolean
data:
type: array
items:
$ref: '#/components/schemas/TimeOff'
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.