OAuth scopes for your applications

When you write your application to integrate with Typeform's APIs, you'll use OAuth 2.0 scopes to define the extent of your application's access to app users' data. This way, your app can request each user's permission to do specific actions on the user's behalf.

You define the scopes for your application during the OAuth 2.0 Authorization Grant retrieval stage. Your application's https://api.typeform.com/oauth/authorize link, including scopes, might look like this:

https://api.typeform.com/oauth/authorize?client_id={your_client_id}&redirect_uri=https://results-example.herokuapp.com/callback&scope={scope1}+{scope2}+{scope3}

NOTE: Don't forget to replace {your_client_id} with your own client_id and each {scope} with the scopes you want to specify.

When your app is up and running, users will see a consent screen that lists the scope of access for your app and prompts them to grant or deny access to your app. Here's an example consent screen:

NOTE: Always add the offline scope to receive a refresh token.

Here's a list of the scopes you can specify for Typeform's APIs: