Skip to main content
GET
/
experiences
JavaScript
import Whopsdk from 'whopsdk';

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

// 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": 1701406800,
      "app": {
        "id": "app_xxxxxxxxxxxxxx",
        "name": "<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"

Response

A successful response

The connection type for PublicExperience.

data
array | null
required

A list of nodes.

page_info
object
required

Information to aid in pagination.

I