In this article, you will learn how to generate and obtain your Workiz API credentials.

The Workiz API is designed to allow you to quickly and easily create a functional application or integration. All of the Workiz APIs are designed around REST (representational state transfer) — a fast and lightweight set of guidelines perfectly suited for app development.

The Developer settings page is organized into two tabs — v2 and v1 — each representing a version of the Workiz API with its own credentials, base URL, and documentation. New accounts open on the v2 tab by default. The v1 API remains available on the v1 tab.

Enabling the feature

In order to generate your API credentials, you will need to enable the developer API add-on from the Feature center/Marketplace.

1. From the navigation bar, select the Feature center

   Not seeing the Feature center icon in the navigation bar? You may not have the correct permissions set for your user.

   Please contact your account admin and ask them to turn on the Account Settings permission for your user type from the Roles & Permissions settings page.

2. Select Developer API

3. Select Get started to enable the add-on

   Pin your favorite features to the sidebar menu for quick access. Features that aren’t pinned won’t appear in the sidebar and can be found in the settings menu.

Opening the Developer settings page

1. From the navigation bar, select the profile icon > Settings

2. Under Integrations, select Developer

   

   Not seeing the Developer settings page? You may not have the correct permissions set for your user.

   Please contact your account admin and ask them to turn on the Account Settings permission for your user type from the Roles & Permissions settings page.

Accessing your v1 API credentials

The v1 API uses a single API Token and API Secret pair for your account.

1. On the Developer page, select the v1 tab
2. If no credentials are shown yet, select Generate API Credentials

3. Copy the API Token and API Secret by selecting the copy icon ( ) next to each

   

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.

Creating and Managing your v2 API keys

Unlike v1, the v2 API uses named API keys, and you can create multiple keys. On the v2 tab, each key is created with a name and an optional expiration date. You can also configure the read/write permissions for each key. All created keys are listed along with their ID, name, and expiration date.

1. On the Developer page, select the v2 tab
2. Select Create New API Key
3. Enter a Key name and set an Expiration for the key
4. Set what Permissions you want this key to have

5. 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.