Retrieve member

JavaScript

import Whop from '@whop/sdk';

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

const member = await client.members.retrieve('id');

console.log(member.id);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/members/{id}",
  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/members/{id}"

	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/members/{id}")

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

{
  "access_level": "no_access",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "<string>",
    "title": "<string>"
  },
  "company_token_balance": 6.9,
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "<string>",
  "joined_at": "2023-12-01T05:00:00.401Z",
  "most_recent_action": "canceling",
  "most_recent_action_at": "2023-12-01T05:00:00.401Z",
  "phone": "<string>",
  "status": "drafted",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "usd_total_spent": 6.9,
  "user": {
    "email": "<string>",
    "id": "<string>",
    "name": "<string>",
    "username": "<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

members

{id}

JavaScript

import Whop from '@whop/sdk';

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

const member = await client.members.retrieve('id');

console.log(member.id);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/members/{id}",
  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/members/{id}"

	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/members/{id}")

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

{
  "access_level": "no_access",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "<string>",
    "title": "<string>"
  },
  "company_token_balance": 6.9,
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "<string>",
  "joined_at": "2023-12-01T05:00:00.401Z",
  "most_recent_action": "canceling",
  "most_recent_action_at": "2023-12-01T05:00:00.401Z",
  "phone": "<string>",
  "status": "drafted",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "usd_total_spent": 6.9,
  "user": {
    "email": "<string>",
    "id": "<string>",
    "name": "<string>",
    "username": "<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 ***************************.

Path Parameters

string

required

The unique identifier of the member to retrieve.

Response

A successful response

A member represents a user's relationship with a company on Whop, including their access level, status, and spending history.

access_level

enum<string>

required

The member's content access level. admin means their team role grants administrative content access, customer means they hold a valid product membership, and no_access means they cannot access company content.

Available options:

no_access,

admin,

customer

company

object

required

The company for the member.

Show child attributes

company_token_balance

number

required

The member's token balance for this company. Computed live from the ledger, not from a cache.

Example:

6.9

created_at

string<date-time>

required

The datetime the company member was created.

Example:

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

string

required

The unique identifier for the company member.

joined_at

string<date-time>

required

When the member joined the company

Example:

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

most_recent_action

enum<string> | null

required

The most recent action the member has taken.

Available options:

canceling,

churned,

finished_split_pay,

paused,

paid_subscriber,

paid_once,

expiring,

joined,

drafted,

left,

trialing,

pending_entry,

renewing,

past_due

most_recent_action_at

string<date-time> | null

required

The time for the most recent action, if applicable.

Example:

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

phone

string | null

required

The phone number for the member, if available.

status

enum<string>

required

The status of the member

Available options:

drafted,

joined,

left

updated_at

string<date-time>

required

The datetime the company member was last updated.

Example:

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

usd_total_spent

number

required

How much money this customer has spent on the company's products and plans

Example:

6.9

user

object | null

required

The user for this member, if any.

Show child attributes

⌘I

Introduction

Ledger stats

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Authorizations

Path Parameters

Response