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.

How to generate your Workiz API credentials

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

  2. Under Add-ons, find Developer API and select Learn more

  3. Turn the toggle switch ON

  4. From the navigation bar, select Settings > Settings

  5. Under Integrations, select Developer

  6. Copy your API token and API secret credentials by selecting the corresponding copy icons

    Tip: You can generate new credentials at any time by selecting Request new credentials.

All API calls to Workiz should be made to the 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.

Need more help? See related articles below:

Did this answer your question?