Scopes
gw2.me API endpoints each require specific permissions. When you authorizing a user, you will need to provide a list of scopes that is required by your application.
This is a list of all supported scopes. Scopes with the prefix gw2:
are Guild Wars 2 API permissions that are set on generated subtokens.
Scope | Description |
---|---|
identify | Get the username from /api/user |
email | Include the email in /api/user |
accounts | Get the list of accounts from /api/accounts. This scope is always implied when any gw2:* scope is included. |
accounts.displayName | Include the user-defined displa name in the account list |
accounts.verified | Include the account verification status. |
gw2:account | Guild Wars 2 API subtokens will include the account permission |
gw2:inventories | Guild Wars 2 API subtokens will include the inventories permission |
gw2:characters | Guild Wars 2 API subtokens will include the characters permission |
gw2:tradingpost | Guild Wars 2 API subtokens will include the tradingpost permission |
gw2:wallet | Guild Wars 2 API subtokens will include the wallet permission |
gw2:unlocks | Guild Wars 2 API subtokens will include the unlocks permission |
gw2:pvp | Guild Wars 2 API subtokens will include the pvp permission |
gw2:wvw | Guild Wars 2 API subtokens will include the wvw permission |
gw2:builds | Guild Wars 2 API subtokens will include the builds permission |
gw2:progression | Guild Wars 2 API subtokens will include the progression permission |
gw2:guilds | Guild Wars 2 API subtokens will include the guilds permission |