ToolWorks
Sign InStart Tracking

Help

ToolWorks API

The ToolWorks API allows you to interact with the ToolWorks application programmatically. It provides a set of endpoints that you can use to retrieve data within the system.

Base URL

ToolWorks API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

The Base URL for all API endpoints is:

https://my.toolworksapp.com/api/v1

Authentication

Authentication to ToolWorks API is performed via the Authorization header with a Bearer token. To authenticate, you need to include the Authorization header with the word Bearer followed by your API key in your requests like so:

Authorization: Bearer twk_xxxxxx

API keys

API keys on ToolWorks allow you to access your data programmatically. This is useful for integrating ToolWorkswith other tools and services.

We recommend, you create separate API key for each integration. This way, the key is tied to a specific integration – allowing you to revoke access to a specific integration if needed.

API keys on ToolWorks follow the format:

TOOLWORKS_API_KEY=twk_xxxxxxxx

Since API keys allow you to access your data programmatically, they must be kept secure and stored securely in your app's server-side code (such as in an environment variable or credential management system). Don’t expose this key on a website.

Create an API key

You can create an API key by following these steps:

  1. Go to you Account settings page.

Go to Settings > Account

  1. Create an API Key

Click on Edit to view editable Account details.

  1. Click on Add New Key

Image: Add API Key

  1. Click on the Create button to create the key. Make sure to copy your API key and store it in a safe place. You won’t be able to see it again.

  2. Use your API Key

Now that you have your API key, you can use it to access your tools programmatically or within any API request as a bearer token.

Authorization: Bearer twk_xxxx
We recommend creating API keys with the least privilege necessary to perform the required tasks. This helps to reduce the risk of unauthorized access to your data.

API key permissions

When creating a secret key, you can select the permissions it has, which will give the key access to certain resources on ToolWorks.

Help