Skip to main content
GET
/
users
/
{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 user = await client.users.retrieve('user_xxxxxxxxxxxxx');

console.log(user.id);
{
  "id": "user_xxxxxxxxxxxxx",
  "username": "johndoe42",
  "name": "John Doe",
  "created_at": "2023-12-01T05:00:00.401Z",
  "bio": "<string>",
  "profile_picture": {
    "url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID (user_xxx) or username of the user

Example:

"user_xxxxxxxxxxxxx"

Response

A successful response

An object representing a (sanitized) user of the site.

​
id
string
required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

​
username
string
required

The username of the user from their Whop account.

Example:

"johndoe42"

​
name
string | null
required

The name of the user from their Whop account.

Example:

"John Doe"

​
created_at
string<date-time>
required

When the user was created.

Example:

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

​
bio
string | null
required

The user's bio

​
profile_picture
object
required

The user's profile picture