The API allows developers to use the OAuth2 protocol to allow a user to grant a 3rd party application partial access to his/her account.


1. Registering your client application

Before integrating the API, you’ll need to register a new OAuth2 application in your dashboard.

2. Redirect users to request access

Redirect users form your application to the authorize page using the necessary scopes. On this page the user can grant authorization to your client application for the scopes you requested.

3. redirects back to your site

If the user approves your application, will redirect them back to your redirect_uri with a temporary code parameter.

Example of the redirect:


4. Exchange code for an access token

After you have received the temporary code, you can exchange it for valid access and refresh tokens using the tokens endpoint.

5. Refreshing tokens

Because the API issues short-lived access tokens, you will need to refresh access tokens using the tokens endpoint via the refresh token that was provided when the access token was issued.

Last updated