How to generate REST API Token

This guide shows how to retrieve a REST API token per user. 

With the August Release 2023, we are introducing a way to generate the REST API Token. The token will be generated per user and it won't expire until the administrator updates it. 


Generate token for the first time

Enable the "REST API Token" under the user type editor. 

Screenshot 2023-08-08 at 13.53.20.png

Once the section has been enabled, go to User Editor Form by right-clicking the user. 

Screenshot 2023-08-08 at 13.55.25.png

Go to the REST API Token tab and click "Enable REST API Token" option. Then the new token will be generated. Copy it and keep it for the 3rd party which is using REST API. 

Note: Once you click the Save button, the token won't be visible anymore. 

Screenshot 2023-08-08 at 13.55.36.png

Regenerate the token 

If you would like to regenerate the token, go to User Edit form -> REST API Token tab. 

Click the "Regenerate Token" button. The system will generate a new token here. 

Warning: Once you click the save button, the old token will be deprecated and won't work anymore. 

Screenshot 2023-08-08 at 13.55.56.png



  • Only (1) token per user
  • Generating a token will override any current token
  • The token can be deleted or disabled through "Enable REST API Token" button. 
  • The generated token won't expire until the administrator regenerates or deletes it.