Retrieve Team Member

Retrieves a team member by ID. email requires the company:authorized_user:email:read scope and is null otherwise.

GET /team_members/{id}

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
});

const teamMember = await client.teamMembers.retrieve('id');

console.log(teamMember.id);

200

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "authorized_role": {
    "id": "<string>",
    "name": "<string>"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "email": "[e-mail]",
  "id": "ausr_xxxxxxxxxxxxxx",
  "is_agent": false,
  "role": "moderator",
  "status": "joined",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  }
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id · string · required

Team member ID — ausr_ for accepted members, ausri_ for pending invites.

Response

200

application/json

Team member retrieved.

account_id · string · required

The account this membership belongs to, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

authorized_role · object | null · required

Custom role assigned to this member, or null when the member has a system role.

Show child attributes

created_at · string · required

When the member joined or the invite was sent, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

email · string | null · required

The member's email address. For accepted members, null unless the caller holds the email read scope; for invites, the invited address.

Example:

"[e-mail]"

id · string · required

Team member ID — ausr_ for accepted members, ausri_ for pending invites.

Example:

"ausr_xxxxxxxxxxxxxx"

is_agent · boolean · required

Whether this member is an agent (app-controlled account) rather than a human team member. Always false for invites.

Example:

false

role · enum<string> · required

The member's role on the account. custom means a bespoke dashboard-managed role; the API can read but not grant it.

Available options: owner, admin, sales_manager, moderator, advertiser, app_manager, support, manager, workforce, custom

Example:

"moderator"

status · enum<string> · required

joined for accepted members, pending while the invite is pending.

Available options: joined, pending

Example:

"joined"

updated_at · string · required

When the membership was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

user · object | null · required

The user behind this team membership. null for an invite sent to an email with no Whop account yet.

Show child attributes