Permissions

Check Permissions

Changed on

Lists permission actions and whether the calling credential is granted each one for a resource. Answers for whichever identity authenticated the request — a user session, an OAuth token, or an account or app API key — so it never describes who else can reach the resource.

get/permissions

Request

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

Query parameters

resource_idstring required

Tag of the resource to check against: an account (biz_), product (prod_), experience (exp_), or app (app_). A resource the credential cannot see is reported as granted nothing rather than as an error.

actionsstring

Comma-separated permission actions to check, for example stats:read,payment:basic:read. Every action is returned when omitted.

Response

permissions listed

Example response

{
  "data": [
    {
      "action": "waitlist_entry:read"
    }
  ]
}

Changes

  • a176ee8d6ff9Revision changes
    • warning

      added the new user:abuse_report:create enum value to the // response property for the response status

  • 0845dd4950f9Revision changes
    • warning

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