API Keys

List the Permission Catalog

Changed on

Lists the catalog of permission actions that can be granted to users, apps, and API keys. Use it to choose the permissions for an API key or to build a permission picker. Small and returned in full on one page.

get/api_keys/permissions

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/api_keys/permissions
  • Auth: HTTP bearer

Response

permission catalog listed

Example response

{
  "data": [
    {
      "action": "waitlist_entry:cancel",
      "allowed_on_user": true,
      "granted_to_system_roles": [
        "owner"
      ],
      "name": "waitlist_entry:cancel"
    }
  ]
}

Changes

  • c19acf2e2548Revision changes
    • warning

      added the new partner enum value to the /// response property for the response status

  • f1020c3ecda4Revision changes
    • info

      added the optional property / to the response with the status