List experiences

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const experienceListResponse of client.experiences.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(experienceListResponse.id);
}

{
  "data": [
    {
      "id": "exp_xxxxxxxxxxxxxx",
      "name": "<string>",
      "order": "123.45",
      "created_at": "2023-12-01T05:00:00.401Z",
      "app": {
        "id": "app_xxxxxxxxxxxxxx",
        "name": "<string>",
        "icon": {
          "url": "<string>"
        }
      },
      "image": {
        "url": "<string>"
      },
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "<string>",
        "route": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

experiences

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const experienceListResponse of client.experiences.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(experienceListResponse.id);
}

{
  "data": [
    {
      "id": "exp_xxxxxxxxxxxxxx",
      "name": "<string>",
      "order": "123.45",
      "created_at": "2023-12-01T05:00:00.401Z",
      "app": {
        "id": "app_xxxxxxxxxxxxxx",
        "name": "<string>",
        "icon": {
          "url": "<string>"
        }
      },
      "image": {
        "url": "<string>"
      },
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "<string>",
        "route": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization

string

header

required

The app API key from an app from the /dashboard/developer page

Query Parameters

after

string | null

Returns the elements in the list that come after the specified cursor.

before

string | null

Returns the elements in the list that come before the specified cursor.

first

integer | null

Returns the first n elements from the list.

Example:

42

last

integer | null

Returns the last n elements from the list.

Example:

42

company_id

string

required

The ID of the company to filter experiences by

Example:

"biz_xxxxxxxxxxxxxx"

product_id

string | null

The ID of the product to filter experiences by

Example:

"prod_xxxxxxxxxxxxx"

app_id

string | null

The ID of the app to filter experiences by

Example:

"app_xxxxxxxxxxxxxx"

created_before

string<date-time> | null

The maximum creation date to filter by

Example:

"2023-12-01T05:00:00.401Z"

created_after

string<date-time> | null

The minimum creation date to filter by

Example:

"2023-12-01T05:00:00.401Z"

Response

A successful response

The connection type for PublicExperience.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The unique ID representing this experience

Example:

"exp_xxxxxxxxxxxxxx"

data.name

string

required

The written name of the description.

data.order

string | null

required

The order of the experience in the section

Example:

"123.45"

data.created_at

string<date-time>

required

The timestamp of when this experience was created.

Example:

"2023-12-01T05:00:00.401Z"

data.app

object

required

The experience interface for this experience.

Show child attributes

data.app.id

string

required

The ID of the app

Example:

"app_xxxxxxxxxxxxxx"

data.app.name

string

required

The name of the app

data.app.icon

object

required

The icon for the app. This icon is shown on discovery, on the product page, on checkout, and as a default icon for the experiences.

Show child attributes

data.app.icon.url

string | null

required

This is the URL you use to render optimized attachments on the client. This should be used for apps.

data.image

object

required

The logo for the experience.

Show child attributes

data.image.url

string | null

required

This is the URL you use to render optimized attachments on the client. This should be used for apps.

data.company

object

required

The company that owns this experience.

Show child attributes

data.company.id

string

required

The ID (tag) of the company.

Example:

"biz_xxxxxxxxxxxxxx"

data.company.title

string

required

The title of the company.

data.company.route

string

required

The slug/route of the company on the Whop site.

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Retrieve review Create experience

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Query Parameters

Response