Authorized users

List authorized users

Changed on

Lists the authorized users on an account's team.

Required permissions:

  • company:authorized_user:read
  • member:email:read
get/authorized_users

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/authorized_users
  • Auth: HTTP bearer

Query parameters

afterstring

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

beforestring

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

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
user_idstring

Filter results to a specific user to check if they are an authorized team member.

Example:user_xxxxxxxxxxxxx
role'owner' | 'admin' | 'partner' | 'sales_manager' | 'moderator' | 'advertiser' | 'app_manager' | 'support' | 'manager' | 'workforce' | 'custom'

Possible roles an authorized user can have

created_beforestring date-time

Only return authorized users created before this timestamp.

Example:2023-12-01T05:00:00.401Z
created_afterstring date-time

Only return authorized users created after this timestamp.

Example:2023-12-01T05:00:00.401Z
account_idstring

The unique identifier of the company to list authorized users for.

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Pickaxe"
      },
      "id": "ausr_xxxxxxxxxxxxx",
      "user": {
        "email": "john.doe@example.com",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    }
  ]
}

Changes

  • c19acf2e2548Revision changes
    • warning

      added the new partner enum value to the // response property for the response status

    • info

      added the new enum value partner to the query request parameter role

  • 697924df40d1Revision changes
    • warning

      deleted the query request parameter company_id

    • info

      added the new optional query request parameter account_id