Skip to main content

Authentication

Using Email and Password​

You can generate an access token for our API using your email and password, with the following endpoint.

API V1 > Authentication > Create an access token.

The endpoint will return an access token that can be used to authenticate with our API, using the Authorization: Bearer <token> header.

success

Email & password is the easiest way to authenticate with the API programmatically. However, for testing you can use the authentication widget below to log in and generate a token, this internally uses the same endpoint as above.

Authentication

or

Unauthenticated

 

As admin in organisation​

You can generate access token for any non-admin user from your organisation with the following endpoint.

API V1 > Organisations > Create User Access Token

The endpoint will return an access token that can be used to authenticate with our API as that given user, using the Authorization: Bearer <token> header.

In order to refresh token after it expires you can either reuse this endpoint or use refresh_token from the response and generate new token with a standard OAuth 2.0 flow passing

{
  "grant_type": "refresh_token",
  "refresh_token": "jjUrveHmH2nCzTLqA8w..."
}

via API V1 > Authentication > Create an access token.