The Gearset API is a REST API that accepts JSON messages over HTTPS. It contains within it a wide range of functionality which allows users to integrate Gearset into external applications.

The first thing you'll need to do to use the API is obtain an access token. Your access token is used for authentication, and it tells the API that you're authorized to make requests.

To create an access token, go to the My account (by clicking the Gearset logo in the top right corner of the app). Then under Team Management > Access Control you'll find Access token management on the left-hand side.

Note: You may need to scroll down a bit to find Team management.

There you'll see a page where you can create and manage access tokens. When you create one, choose the API scopes the token needs and if you are a team owner you can also decide whether it's for Personal or Team use.

If you can't see the Access token management section on your account or are able to create a Gearset API Token, please make sure that the permission to Create API Personal Access Token is enabled on your user or team.

This can be found and enabled by a Team Owner under Gearset Permissions as well as individual user permissions:

When creating your token, enter a recognizable name that will help you identify the token in the future. You can also change the expires in value at this point.

Click Create new token and you’ll be presented with a dialog like the one below, showing the name, what it's used for and the generated secret.

Your access tokens are listed in a single table on the same page. Each row shows the Owner, the tokens Name, its API scopes, and when it was Created, Last used, and when it Expires on. Your own tokens come first, then your team's tokens, then tokens belonging to other teammates.

Team owners see personal access tokens created by anyone on the team, and can revoke any of them. The confirmation names the owner when you revoke a token that belongs to someone else. Team owners can't change the expiry date on another person's token, only revoke it.

If you're not a team owner, you see your own personal tokens and your team's tokens.

Revoking a token is permanent, and any integration still using it stops working.

You can also check all the expired access tokens by scrolling down below the Active access tokens section

Now you have a token, and you can start using the Gearset API:

For further technical details on the Gearset API see: