Authentication

You'll need to authenticate your requests to access any of the endpoints in the Clarity API. In this guide, we'll look at how authentication works. Clarity offers two ways to authenticate your API requests: Basic authentication and OAuth2 with a token — OAuth2 is the recommended way.

OAuth2 with bearer token

The recommended way to authenticate with the Clarity API is by using OAuth2. When establishing a connection using OAuth2, you will need your access token — you will find it in the Clarity Dashboard under API settings. Here's how to add the token to the request header using cURL:

curl https://api.clarityapp.ai/v1/conversations \
  -H "Authorization: Bearer {token}"

Always keep your token safe and reset it if you suspect it has been compromised.