GET
/
v2
/
customers
/
{search}
Header
Path
curl --request GET \
  --url https://api.whop.com/v2/customers/{search}
{
  "authorized_user": {
    "company": "string",
    "permission_level": "string",
    "role": "owner"
  },
  "email": "string",
  "id": "string",
  "profile_pic_url": "string",
  "roles": "string",
  "social_accounts": {
    "id": "string",
    "service": "string",
    "username": "string"
  },
  "username": "string"
}

Headers

Authorization
string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

searchrequired
string

Any identifier that can be used to represent a User. This can be a Whop account ID, Discord account ID, or email address

Response

200 - application/json
authorized_user
object
email
string

The User's email address

id
string

The ID of the User, which will look like user_*************

profile_pic_url
string

An image URL of the User's profile photo, primarily pulled from Discord

roles
string
social_accounts
object
username
string

The User's Whop username