Accessing your Workiz API credentials

  • Updated

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.

Enabling the add-on

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

  1. From the navigation bar, select the Marketplace

    Not seeing the Marketplace 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. Under Add-ons, select Developer API
    2023-05-02_15-34-48API.png
  3. Turn the toggle switch on/off to enable/disable the add-on
    2023-05-02_15-51-04API.png

Accessing your API credentials

  1. From the navigation bar, select the gear icon ( ) > Settings
  2. Under Integrations, select Developer
    2023-05-02_16-02-38.png
  3. Copy your credentials by selecting the copy icon ( )
  4. API token and API secret credentials by selecting the corresponding copy icons
    Group 4590.png

All 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 our API documentation, please click here.

Was this article helpful?