Sign in
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. Listing role=workforce is also allowed with the bounty:create scope.

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' | '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 members to return. Defaults to 20; maximum 100.

afterstring

Cursor for the next page of members.

lastinteger

Number of members to return from the end of the window.

beforestring

Cursor to paginate backwards from.

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": "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"
      }
    }
  ],
  "page_info": {
    "end_cursor": "Mw",
    "start_cursor": "MQ"
  }
}

Changes

Changed in 4 of the 41 revisions of this API.19

  • f67a043e31903See the full diff
    • ○

      added the new optional query request parameter before

      new-optional-request-parameter

    • ○

      added the new optional query request parameter last

      new-optional-request-parameter

    • ○

      added the required property data/items/authorized_role to the response with the 200 status

      response-required-property-added

  • ae20b30817de11See the full diff
    • ●

      added the new workforce enum value to the data/items/role response property for the response status 200

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

  • f1020c3ecda44See the full diff
    • ○

      added the optional property error/code to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property error/code to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property error/code to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property error/code to the response with the 404 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog