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

​
id
string
required
Team member ID — ausr_ for accepted members, ausri_ for pending invites.
​
account_id
string
required
The account this membership belongs to, prefixed biz_.
​
created_at
string
required
When the member joined or the invite was sent, as an ISO 8601 timestamp.
​
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.
​
is_agent
boolean
required
Whether this member is an agent (app-controlled account) rather than a human team member. Always false for invites.
​
role
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, custom
​
status
string
required
joined for accepted members, pending while the invite is pending.Available options: joined, pending
​
updated_at
string
required
When the membership was last updated, as an ISO 8601 timestamp.
​
user
object | null
required
The user behind this team membership. null for an invite sent to an email with no Whop account yet.

Properties

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

Properties

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