Skip to main content
All API endpoints on TrueState can be used with an API key. An API key is tied to an Organisation, and a user with the API key will be able to perform actions within its Organisation. For a complete list of API endpoints, see the API Reference.

​
Creating API Keys

To create an API key, navigate to settings then click the API Keys tab. Click create API key, and provide a name for the key. Make sure this name is detailed and explains what this key will be used for and why it exists. Once created, the API key will be displayed on screen. Save this into a secure location as it will not be accessible again. Show all API keys

​
Using API Keys

An API key can be used by providing it in the field within the OpenAPI documentation for the endpoint. This provides it as a request header curl -H parameter. It can also be provided manually to a curl request with the header structure: ‘Api-key: test’.

​
Deleting API Keys

If an API key is no longer needed or has been lost, click the 3 dots next to the key and select Delete to remove this API key.
⌘I