Skip to main content
GET
/
users
/
{id}
/
access
/
{resource_id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const response = await client.users.checkAccess('resource_id', { id: 'user_xxxxxxxxxxxxx' });

console.log(response.access_level);
{
  "has_access": true
}

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.

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The unique identifier or username of the user.

Example:

"user_xxxxxxxxxxxxx"

​
resource_id
string
required

The unique identifier of the resource to check access for. Accepts a company, product, or experience identifier.

Response

A successful response

The result of a has access check for the developer API

​
has_access
boolean
required

Whether the user has access to the resource

​
access_level
enum<string>
required

The permission level of the user

Available options:
no_access,
admin,
customer