Skip to main content
GET
/
members
/
{id}
JavaScript
import Whop from '@whop/sdk';

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

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

console.log(member.id);
{
  "id": "<string>",
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "joined_at": "2023-12-01T05:00:00.401Z",
  "access_level": "no_access",
  "status": "drafted",
  "most_recent_action": "canceling",
  "most_recent_action_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "username": "<string>"
  },
  "phone": "<string>",
  "usd_total_spent": 6.9,
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "<string>",
    "route": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

A successful response

An object representing a connection between a creator and a user/company_buyer. This type should only be made visible to the user/company_buyer who is a part of the connection.

​
id
string
required

The ID of the member

​
created_at
string<date-time>
required

When the member was created

Example:

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

​
updated_at
string<date-time>
required

The timestamp of when this member was last updated

Example:

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

​
joined_at
string<date-time>
required

When the member joined the company

Example:

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

​
access_level
enum<string>
required

The access level of the product member. If its admin, the member is an authorized user of the access pass. If its customer, the member has a valid membership to the access pass. If its no_access, the member does not have access to the access pass.

Available options:
no_access,
admin,
customer
​
status
enum<string>
required

The status of the member

Available options:
drafted,
joined,
left
​
most_recent_action
enum<string> | null
required

The most recent action the member has taken. The different most recent actions a member can have.

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"

​
user
object | null
required

The user for this member, if any.

​
phone
string | null
required

The phone number for the member, if available.

​
usd_total_spent
number
required

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

Example:

6.9

​
company
object
required

The company for the member.

⌘I