v8

OpenAPI 3.1.02026-08-033623795.0 MB
Experiences

List experiences

Returns a paginated list of experiences belonging to a company, with optional filtering by product and app.

get/experiences

Query parameters

afterstring nullable

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

beforestring nullable

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

firstinteger nullable

Returns the first n elements from the list.

Example:42
lastinteger nullable

Returns the last n elements from the list.

Example:42
company_idstring required

The unique identifier of the company to list experiences for.

Example:biz_xxxxxxxxxxxxxx
product_idstring nullable

Filter to only experiences attached to this product identifier.

Example:prod_xxxxxxxxxxxxx
app_idstring nullable

Filter to only experiences powered by this app identifier.

Example:app_xxxxxxxxxxxxxx
created_beforestring date-time nullable

Only return experiences created before this timestamp.

Example:2023-12-01T05:00:00.401Z
created_afterstring date-time nullable

Only return experiences created after this timestamp.

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

Response

A successful response

Example response

{
  "data": [
    {
      "app": {
        "icon": {
          "url": "https://media.whop.com/abc123/optimized.jpg"
        },
        "id": "app_xxxxxxxxxxxxxx",
        "name": "Courses"
      },
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "route": "pickaxe",
        "title": "Pickaxe"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "exp_xxxxxxxxxxxxxx",
      "image": {
        "url": "https://media.whop.com/abc123/optimized.jpg"
      },
      "name": "Trading Signals Chat",
      "order": "123.45"
    }
  ]
}