In this article, you will learn what you can do with the Workiz API and how to generate and obtain your API credentials.
The Workiz API lets you connect Workiz to other tools and build your own apps or integrations. All of the Workiz APIs are designed around REST (representational state transfer): a fast and lightweight set of guidelines perfectly suited for app development.
What's possible with the API
With the API, you can read and update your Workiz data from outside the app. For example, you can:
-
Create new clients
Add clients to Workiz automatically from a website form, CRM, or other system -
Update existing jobs
Change job details, statuses, or assigned team members -
Retrieve a list of invoices
Pull invoices into your accounting or reporting tools -
And more
Work with leads, estimates, schedule events, timesheets, tags, custom fields, and webhooks
To see everything the API supports, view the Workiz API v2 documentation.
The Developer settings page has two tabs (v2 and v1) each with its own credentials, base URL, and documentation. New accounts open on the v2 tab by default. The v1 API is still available on the v1 tab.
Enabling the feature
To generate your API credentials, you need to enable the Developer API add-on from the Feature center.
- From the navigation bar, select the Feature center
- Select Developer API
- Select Get started to enable the add-on
Accessing your API credentials
To access your credentials, open the Developer settings page:
- From the navigation bar, select the profile icon > Settings
- Under Integrations, select Developer
v2
Unlike v1, the v2 API uses named API keys, and you can create multiple keys. Each key has a name, an optional expiration date, and its own permissions. All created keys are listed along with their ID, name, and expiration date.
- On the Developer page, select the v2 tab
- Select Create New API Key
- Enter a Key name and set an Expiration for the key
- Set the Permissions for this key. You can either:
- Give the key full access to all resources, or
- Give it specific access to only the resources it needs, and choose Read or Read & Write for each one
- Search
- Jobs
- Leads
- Clients
- Invoices
- Estimates
- Job Types
- Ad groups
- Custom fields
- Tags
- Availability
- Users
- Events
- Timesheet
- Time off
- Copy and securely store the key before leaving the page
Once you leave this page, the API key will no longer be visible. Make sure to copy and securely store your key before navigating away.
From the keys list, you can also Edit, Rotate, or Delete a key, or view its logs. Rotating a key generates a new secret and immediately invalidates the current key.
To view the v2 API documentation, please click here.
v1
The v1 API uses a single API Token and API Secret pair for your account.
- On the Developer page, select the v1 tab
- If no credentials are shown yet, select Generate API Credentials
- Copy the API Token and API Secret by selecting the copy icon next to each
Selecting Request New Credentials generates a new token and secret and immediately invalidates the current ones. Any integration using the previous credentials will stop working until you update it.
All v1 API calls to Workiz should be made to the https://api.workiz.com/api/v1/ base domain. A JSON will be returned in all responses from the API, including errors. The APIs are designed to have predictable, straightforward URLs and to use HTTP response codes to indicate API errors.
To view the v1 API documentation, please click here.