To get started with our API, we recommend you create a wrapper that handles the signing of requests, and test it on our Test endpoint. It will let you run all types of requests and see whether your implementation is correct.

<aside> ⚠️ Please refer to Authentication methods as each authentication method requires specific headers

</aside>

Query strings

All query strings need to be URL encoded. For example:

/api/[email protected]

Has to be encoded as:

/api/test?email=john%40doe.com

Impersonating organisation user

Some API requests accept a impersonate-user query parameter. This parameter is the email address of the user, as it is recorded in our database, and is used to impersonate this user to execute the actions for him.

The user you want to impersonate must be part of your organisation and must have the permissions required to execute the requested action.