Skip to main content
A Team Member is a member of an account’s team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like admin or moderator) or custom roles managed from the dashboard. Use the Team Members API to list an account’s team, add a user to the team with a system role, change a member’s role, and remove members. Adding a user who has not yet accepted sends an invitation instead.

​
Endpoints

​
Attributes

​
string
required
Team member ID. Accepted members have an ID starting with ausr_ or mber_, and pending invites one starting with ausri_. Treat it as opaque: both member prefixes are accepted wherever a team member ID is.
​
string
required
The account this membership belongs to, prefixed biz_.
​
object | null
required
Custom role assigned to this member, or null when the member has a system role.

Properties

​
string
required
Custom role ID, prefixed aurl_.
​
string
required
Custom role name.
​
string
required
When the member joined the team or the invite was sent, as an ISO 8601 timestamp. A member who was a customer first keeps the date they were given their role.
​
integer | null
required
How many team members report directly to this member. null for invites.
​
string | null
required
The member’s email address. For an invite sent to an email with no Whop account yet, the invited address; for accepted members and invites to an existing Whop account, null unless the caller holds the company:authorized_user:email:read scope.
​
boolean
required
Whether this member is an agent (app-controlled account) rather than a human team member. Always false for invites.
​
string | null
required
The ID of the team member this member reports to, starting with ausr_ or mber_; treat it as opaque. null when the member reports to the business directly, and for invites.
​
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, partner, sales_manager, moderator, advertiser, app_manager, support, manager, workforce, custom
​
string
required
joined for accepted members, pending while the invite is pending.Available options: joined, pending
​
string
required
When the membership was last updated, as an ISO 8601 timestamp.
​
object | null
required
The user behind this team membership. null for an invite sent to an email with no Whop account yet.

Properties

​
string
required
User ID, prefixed user_.
​
string | null
required
Display name.
​
object
required
Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

Properties

​
string
required
Avatar image URL. Always present — a generated placeholder when the user set no picture.
​
string
required
Public username.
TeamMember