Skip to main content
GET
Retrieve member
This page documents the Legacy API. For new integrations, use Retrieve Member in the Current API.
Required permissions:
  • member:basic:read
  • member:email:read
  • member:phone:read

Autorizaciones

Authorization
string
header
requerido

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

Scopes

member:basic:read
member:email:read
member:phone:read

Parámetros de ruta

id
string
requerido

The unique identifier of the member to retrieve.

Respuesta

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>
requerido

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.

Opciones disponibles:
no_access,
admin,
customer
company
object
requerido

The company for the member.

company_token_balance
number
requerido

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

Ejemplo:

6.9

created_at
string<date-time>
requerido

The datetime the company member was created.

Ejemplo:

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

id
string
requerido

The unique identifier for the company member.

joined_at
string<date-time>
requerido

When the member joined the company

Ejemplo:

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

most_recent_action
enum<string> | null
requerido

The most recent action the member has taken.

Opciones disponibles:
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
requerido

The time for the most recent action, if applicable.

Ejemplo:

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

phone
string | null
requerido

The phone number for the member, if available.

status
enum<string>
requerido

The status of the member

Opciones disponibles:
drafted,
joined,
left
updated_at
string<date-time>
requerido

The datetime the company member was last updated.

Ejemplo:

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

usd_total_spent
number
requerido

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

Ejemplo:

6.9

user
object | null
requerido

The user for this member, if any.