We are here and ready to help.

How to create an API token

In order to access the REST API, you will need to enable API access to the user account and create an API token you can use to acces the REST API.

Add API access to the user API

  1. Click on “Configuration” → “Organization” → “Roles”.
     
  2. Click on the role of the agent you want to add the permission to. i.e. “Administrator”
     
  3. Click on Administration, and enable the option “Ability to access API webservices”.


     
  4. Save the role and it should be all setup to access the API.

 

How to create a JWT API token

To create a new JWT token:

  1. Click on “Configuration” → “API” → “API Tokens”.
     
  2. Click on “Add New Token” at the top right corner.
     
  3. Name the token for your reference.
     
  4. Choose an expiry date for the token, or leave it blank for unlimited access.
    * Warning, once you create the token, the token is valid until the expiry date or the agent is deleted or set as inactive.
     
  5. Save the token, and it will be created for you.

 

Full REST API documentation

The full API documentation can be found here: https://supportbench.readme.io/docs/introduction

Facebook Share Tweet

Was this article helpfu?

Yes No

Thank you for voting

×
Select company

You are related to multiple companies. Please select the company you wish to login as.