List products

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 productListItem of client.products.list({ account_id: 'account_id' })) {
  console.log(productListItem.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "external_identifier": "ext_prod_12345",
      "gallery_images": [
        {
          "content_type": "image/jpeg",
          "id": "<string>",
          "url": "https://media.whop.com/abc123/optimized.jpg"
        }
      ],
      "headline": "Real-time data analytics for creators",
      "id": "prod_xxxxxxxxxxxxx",
      "member_count": 42,
      "metadata": {},
      "published_reviews_count": 42,
      "route": "pickaxe-analytics",
      "title": "Pickaxe Analytics",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "verified": true,
      "visibility": "visible"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

GET

products

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 productListItem of client.products.list({ account_id: 'account_id' })) {
  console.log(productListItem.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "external_identifier": "ext_prod_12345",
      "gallery_images": [
        {
          "content_type": "image/jpeg",
          "id": "<string>",
          "url": "https://media.whop.com/abc123/optimized.jpg"
        }
      ],
      "headline": "Real-time data analytics for creators",
      "id": "prod_xxxxxxxxxxxxx",
      "member_count": 42,
      "metadata": {},
      "published_reviews_count": 42,
      "route": "pickaxe-analytics",
      "title": "Pickaxe Analytics",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "verified": true,
      "visibility": "visible"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Query Parameters

after

string

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

before

string

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

first

integer

Returns the first n elements from the list.

Example:

42

last

integer

Returns the last n elements from the list.

Example:

42

company_id

string

required

The unique identifier of the company to list products for.

Example:

"biz_xxxxxxxxxxxxxx"

product_types

enum<string>[]

Filter to only products matching these type classifications.

The different types an product can be. Only use 'regular'. The rest are for internal use

Available options:

regular,

app,

experience_upsell,

api_only

visibilities

enum<string>[]

Filter to only products matching these visibility states.

The different levels of visibility for resources

Available options:

visible,

hidden,

archived,

quick_link,

all,

not_quick_link,

not_archived

order

enum<string>

The field to sort results by. Defaults to created_at.

Available options:

active_memberships_count,

created_at,

usd_gmv,

usd_gmv_30_days

direction

enum<string>

The sort direction for results. Defaults to descending.

Available options:

asc,

desc

created_before

string<date-time>

Only return products created before this timestamp.

Example:

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

created_after

string<date-time>

Only return products created after this timestamp.

Example:

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

Response

A successful response

The connection type for PublicAccessPass.

data

object[]

required

A list of nodes.

Show child attributes

page_info

object

required

Information to aid in pagination.

Show child attributes

⌘I

Introduction

Ledger stats

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Authorizations

Query Parameters

Response