> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Permissions

> Configure the permissions that your app needs

To retrieve private data and perform actions on behalf of companies, your app needs to be installed on the company.

A creator can install your app by finding it in the app store, or by visiting your "direct install" link
which looks like: `https://whop.com/apps/app_xxxxxxxxx` (where `app_xxxxxxxxx` is the id of your app).

Your app can only make calls if it has the required permissions for the api call.
Every endpoint documents it's required permissions in the api reference.

<Note>
  We are working on a full OAuth based permission mode that will allow apps to
  request permissions from users directly and operate on their behalf.
</Note>

## Request permissions

<Warning>
  The permissions flow is still required even if you are trying to access data
  on your own company. This will ensure your app works the same on your company
  as well as when it is installed by others.
</Warning>

<Steps>
  <Step title="Go to your app's permissions settings">
    1. Go to the [developer dashboard](https://whop.com/dashboard/developer)
    2. Select or create an app
    3. Click on the **Permissions** tab

    <Frame>
      <img src="https://mintcdn.com/whop/CTin6M1qeROeLXJs/images/app-permissions-settings.png?fit=max&auto=format&n=CTin6M1qeROeLXJs&q=85&s=514a98987e714d5a2542b3d7665020f7" alt="Permissions Settings" width="2120" height="722" data-path="images/app-permissions-settings.png" />
    </Frame>
  </Step>

  <Step title="Add permissions">
    1. Click on **Add permissions** 2. Select the permissions you want to add 3.
       Confirm by clicking **Add**
  </Step>

  <Step title="Configure each permission">
    1. Write a short explanation for why your app needs the permission
    2. Choose whether the permission is required or optional. Creators will be able to toggle off optional permissions during install.

    <Frame>
      <img src="https://mintcdn.com/whop/CTin6M1qeROeLXJs/images/app-permissions-settings-justification.png?fit=max&auto=format&n=CTin6M1qeROeLXJs&q=85&s=93ec46a13be088ad236a7fe69f6f6ad2" alt="Permissions Justification" width="2120" height="722" data-path="images/app-permissions-settings-justification.png" />
    </Frame>
  </Step>

  <Step title="Save your permissions">
    <Frame>
      <img src="https://mintcdn.com/whop/CTin6M1qeROeLXJs/images/app-permissions-settings-save.png?fit=max&auto=format&n=CTin6M1qeROeLXJs&q=85&s=683b42f4dcfed0eeee535d82dcce3e5f" alt="Save Permissions Settings" width="1074" height="178" data-path="images/app-permissions-settings-save.png" />
    </Frame>
  </Step>

  <Step title="Install your app">
    1. Visit your app's direct install link: `https://whop.com/apps/app_xxxxxxxxx/install` (where `app_xxxxxxxxx` is the id of your app).
    2. Select your company you want to install the app on
    3. Approve the permissions you requested
  </Step>
</Steps>

Creators will now need to approve the permissions you requested before installing your app:

<Frame>
  <img src="https://mintcdn.com/whop/CTin6M1qeROeLXJs/images/app-permissions-oauth.png?fit=max&auto=format&n=CTin6M1qeROeLXJs&q=85&s=4b427b52f269ee6b92fcf7434069ad43" alt="Permissions Prompt" width="2176" height="2222" data-path="images/app-permissions-oauth.png" />
</Frame>

## Updating your permissions

You can update your requested permissions anytime. Creators will see a "Re-approve" button when they visit your app.

Creators can always update their granted permissions and re-approve new permissions in their [Authorized apps](https://whop.com/dashboard/settings/authorized-apps) settings page.

To manually navigate to the settings, go to: `Dashboard -> Settings -> Authorized apps`

<video controls className="rounded-xl" src="https://mintcdn.com/whop/_aQsA39rzB5Zq8ZK/how-to-videos/configure-app-permissions.mp4?fit=max&auto=format&n=_aQsA39rzB5Zq8ZK&q=85&s=dff99f10fb43e8914fdcd1b0eb4bd044" data-path="how-to-videos/configure-app-permissions.mp4" />

## FAQ

<AccordionGroup>
  <Accordion title="How many permissions can I request?">
    You can request up to 100 permissions.
  </Accordion>

  <Accordion title="How do I know which permissions I need?">
    You can find the required permissions for each SDK method documented in the
    [API reference](/api-reference/payments/list-payments).

    <Frame>
      <img src="https://mintcdn.com/whop/purcney6SuEUQzS5/images/sdk-reference-required-permissions.png?fit=max&auto=format&n=purcney6SuEUQzS5&q=85&s=141d5a09a00942f216c98d233824dcf9" alt="SDK Reference Permissions" width="1478" height="358" data-path="images/sdk-reference-required-permissions.png" />
    </Frame>
  </Accordion>

  <Accordion title="Can I request additional permissions afterwards?">
    Yes. You can request additional permissions and the creator will be asked to re-approve them.

    <Note>
      Keep in mind that until the permissions are re-approved, API requests requiring the **newly requested** permissions will fail. Make sure to handle these errors gracefully in your code.
    </Note>

    <Warning>
      When developing your app, make sure you re-approve the permissions yourself in your [Authorized apps](https://whop.com/dashboard/settings/authorized-apps) settings.

      See [Configure your permissions](/developer/guides/permissions#updating-your-permissions) for more information.
    </Warning>
  </Accordion>
</AccordionGroup>