Team Members

List Team Members

Changed on

Lists an account's team members, including pending invites. A user credential with company:basic:read may list only its own joined membership by passing its own user_id and status=joined. Listing role=workforce is also allowed with the bounty:create scope.

get/team_members

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/team_members
  • Auth: HTTP bearer

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' | 'partner' | 'sales_manager' | 'moderator' | 'advertiser' | 'app_manager' | 'support' | 'manager' | 'workforce' | '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 results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

Team members listed.

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "created_at": "2026-01-01T12:00:00.000Z",
      "email": "marcus@shinetime.example",
      "id": "ausr_xxxxxxxxxxxxxx",
      "role": "admin",
      "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"
      }
    }
  ],
  "page_info": {
    "start_cursor": "MQ"
  }
}

Changes

  • ff3a76573563Revision changes
    • breaking

      for the query request parameter first, default value 20 was added

    • warning

      for the query request parameter first, the max was set to 100.00

  • c19acf2e2548Revision changes
    • warning

      added the new partner enum value to the // response property for the response status

    • info

      added the new enum value partner to the query request parameter role