List users

Search for users by name or username, ranked by social proximity to the authenticated user.

GET /users

JavaScript

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 userListResponse of client.users.list()) {
  console.log(userListResponse.id);
}

200

{
  "data": [
    {
      "id": "user_xxxxxxxxxxxxx",
      "username": "johndoe42",
      "name": "John Doe",
      "created_at": "2023-12-01T05:00:00.401Z",
      "bio": "building cool things on the internet",
      "profile_picture": {
        "url": "https://media.whop.com/abc123/optimized.jpg"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization · string · header · required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Query Parameters

after · string | null

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

before · string | null

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

first · integer | null

Returns the first n elements from the list.

Example:

42

last · integer | null

Returns the last n elements from the list.

Example:

42

query · string | null

Search term to filter by name or username.

Response

200

application/json

A successful response

The connection type for PublicProfileUser.

data · object[] · required

A list of nodes.

Show child attributes

page_info · object · required

Information to aid in pagination.

Show child attributes