v1

latestOpenAPI 3.1.02026-07-14305.3 KB
OAuth 2.0

Authorize Endpoint

Use open source libraries to perform OAuth 2.0. You can find a list of libraries here: https://oauth.net/code/

get/authorize

Query parameters

client_idstring uuid required

The client ID of your integration (this can be found in your integration settings page).

response_type'code' required

The response type. This should always be code.

redirect_uristring uri required

The URL to redirect to after the user has authorized the integration. This URL must exactly match one of the registered redirect URLs in your integration settings page.

statestring

A random string to prevent CSRF attacks. You should set this when starting the OAuth flow and check that when the user is redirected back to your app that it matches this value.