Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Team Members

List Team Members

Lists an account's team members, including pending invites (status: "pending", ausri_ ids; user is null for invites sent to an email with no Whop account yet). For accepted members, email requires the company:authorized_user:email:read scope and is null otherwise.

get/team_members

Query parameters

account_idstring required

Account ID, prefixed biz_.

status'joined' | 'pending'

Only return members with this status: joined (accepted members) or pending (pending invites). Both are returned by default.

user_idstring

Only return the membership for this user ID, prefixed user_.

role'owner' | 'admin' | 'sales_manager' | 'moderator' | 'advertiser' | 'app_manager' | 'support' | 'manager' | 'custom'

Only return members with this role. custom matches members on a dashboard-managed custom role.

created_beforestring

Only return members added before this ISO 8601 timestamp.

created_afterstring

Only return members added after this ISO 8601 timestamp.

order'created_at'

Field used to sort members.

direction'asc' | 'desc'

Sort direction. Defaults to desc.

firstinteger

Number of members to return. Defaults to 20; maximum 100.

afterstring

Cursor for the next page of members.

Response

Team members listed.

Example response

{
  "data": [
    {
      "role": "owner",
      "status": "joined"
    }
  ]
}