Skip to main content

Scopes

Scopes are used within the API to determine which clients have access to which resources. You should determine a list of scopes that you need by browsing the API documentation and send it to the board upon request for registering your client.

Scopes can be updated later on, if you require more access. If you request more scopes and use the User API Access, the user will be requested to approve your app again, even if they have already approved an earlier request. This ensures that all users always see which data you are requesting.

Here's a full list of all scopes that are available for request:

ScopeDescription
profileObtain the name of a user
emailObtain the email address of a user