Skip to content

Authentication

Every request to the Responsly API is authenticated with a personal access token. A token acts on behalf of the account that created it, with that account’s access to forms, responses and contacts.

  1. In Responsly, open your profile and go to API keys.
  2. Create a token. Give it a name that says where it is used, for example CRM sync or Data warehouse, so you can tell your tokens apart later.
  3. Copy the token and store it in your secret manager or environment variables.

Put the token in the Authorization header of every request:

Authorization: Bearer <token>

A request without a valid token is refused.

GET https://api.responsly.com/v1/test-auth
Terminal window
curl https://api.responsly.com/v1/test-auth \
-H "Authorization: Bearer <token>"

When the token works, the response is the e-mail address of the account it belongs to:

{
"email": "joe@example.com"
}
  • Treat a token like a password. Keep it on your server and out of browser code, mobile apps and public repositories.
  • Use a separate token for each integration, so you can delete one without stopping the others.
  • Delete a token you no longer use, or one that may have leaked, on the API keys page. The team’s owner or an admin can delete any token of the team.