Whop Developers home page
GraphQL API
Search...
⌘K
Ask AI
Start Building
Start Building
Search...
Navigation
GraphQL API
Scopes
Documentation
SDK Reference
API Reference
GraphQL API
Authentication
Scopes
Schema
Examples
Rate Limits
On this page
Available scopes
GraphQL API
Scopes
An overview of authorization scopes for the Whop API
When calling the Whop API on behalf of a user or a company you need to first obtain permissions to do so.
Obtain permission by either:
embedded apps
- setting your required scopes in your app’s settings in the
Whop dashboard
standalone apps
- using the
scopes
parameter when using
Whop OAuth
Once you have obtained permissions you can use your app’s API key to make calls on behalf of the user or company.
Available scopes
read_user
: Read the user’s basic details. This scope is required and will be automatically granted when users open embedded apps.
Was this page helpful?
Yes
No
Authentication
Schema
Assistant
Responses are generated using AI and may contain mistakes.