Skip to main content
GET
/
authorized_users
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 authorizedUserListResponse of client.authorizedUsers.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(authorizedUserListResponse.id);
}
{
  "data": [
    {
      "id": "ausr_xxxxxxxxxxxxx",
      "role": "owner",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42",
        "email": "[email protected]"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

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

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

​
company_id
string
required

The ID of the company to list authorized users for

Example:

"biz_xxxxxxxxxxxxxx"

​
user_id
string | null

Filter by the user ID to check if the user is an authorized user

Example:

"user_xxxxxxxxxxxxx"

​
role
enum<string> | null

Filter by the role of the authorized user to list

Available options:
owner,
admin,
sales_manager,
moderator,
app_manager,
support,
manager
​
created_before
string<date-time> | null

The maximum creation date to filter by

Example:

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

​
created_after
string<date-time> | null

The minimum creation date to filter by

Example:

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

Response

A successful response

The connection type for AuthorizedUser.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.