GET
/
access_passes
/
{id}
JavaScript
import Whopsdk from 'whopsdk';

const client = new Whopsdk({
  apiKey: 'My API Key',
});

const accessPass = await client.accessPasses.retrieve('prod_xxxxxxxxxxxxx');

console.log(accessPass.id);
{
  "id": "prod_xxxxxxxxxxxxx",
  "title": "<string>",
  "verified": true,
  "business_type": "education_program",
  "industry_type": "trading",
  "created_at": 1701406800,
  "updated_at": 1701406800,
  "member_count": 42,
  "route": "<string>",
  "published_reviews_count": 42,
  "owner_user": {
    "id": "user_xxxxxxxxxxxxx",
    "username": "<string>",
    "name": "<string>"
  }
}

Path Parameters

​
id
string
required
Example:

"prod_xxxxxxxxxxxxx"

Response

A successful response

An object representing a (sanitized) access pass.

​
id
string
required

The internal ID of the public access pass.

Example:

"prod_xxxxxxxxxxxxx"

​
title
string
required

The title of the access pass. Use for Whop 4.0.

​
verified
boolean
required

Whether this product is Whop verified.

​
business_type
enum<string> | null
required

The type of business the company is.

Available options:
education_program,
coaching,
software,
paid_group,
newsletter,
agency,
physical_products,
brick_and_mortar,
events,
coaching_and_courses,
other,
saas,
course,
community
​
industry_type
enum<string> | null
required

The specific industry the company operates in.

Available options:
trading,
sports_betting,
reselling,
fitness,
amazon_fba,
real_estate,
kindle_book_publishing,
dating,
agencies,
health_and_wellness,
social_media,
sales,
business,
ecommerce,
video_games,
home_services,
ai,
public_speaking,
personal_finance,
careers,
travel,
clipping,
spirituality,
vas,
personal_development,
software,
other,
marketing_agency,
sales_agency,
ai_agency,
design_agency,
coaching_agency,
development_agency,
recruiting_agency,
customer_support_agency,
clipping_agency,
clothing,
supplements,
beauty_and_personal_care,
fitness_gear,
accessories,
home_goods,
electronics_and_gadgets,
food_and_beverages,
gym,
restaurant,
retail_store,
coffee_shop,
salon_spa,
medical_dentist_office,
hotel_lodging,
auto_repair_shop,
masterminds,
webinars,
bootcamps,
convention,
concerts,
meetups,
parties
​
created_at
integer
required

When the access pass was created.

Example:

1701406800

​
updated_at
integer
required

When the access pass was updated.

Example:

1701406800

​
member_count
integer
required

The number of active users for this access pass.

Example:

42

​
route
string
required

The route of the access pass.

​
published_reviews_count
integer
required

The number of reviews that have been published for the access pass.

Example:

42

​
owner_user
object
required

The user that owns the access pass (company owner).