Members

List Members

Changed on

Lists the members of an account. A member is one buyer's relationship with the account, regardless of how many memberships they hold.

get/members

Request

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

Query parameters

account_idstring

The account to list members for (biz_ tag). Defaults to the account the credential acts as.

access_level'no_access' | 'admin' | 'customer'

Filter by what the member can reach on the account.

status'joined' | 'left'

Filter by whether the member is still part of the account.

user_idsstring[]

Only return members whose users match these user_ identifiers.

[
  "user_xxxxxxxxxxxxxx"
]
most_recent_actionsstring[]

Only return members whose most_recent_action is one of these values.

membership_status'active' | 'inactive'

active returns members holding at least one membership that currently grants access; inactive returns members holding at least one membership that does not. Combined with product_ids, plan_ids, or promo_code_ids, one membership must match all of them.

product_idsstring[]

Only return members holding a membership to one of these products, prefixed prod_. Unknown IDs match nothing.

[
  "prod_xxxxxxxxxxxxx"
]
plan_idsstring[]

Only return members holding a membership on one of these plans, prefixed plan_. Unknown IDs match nothing.

[
  "plan_xxxxxxxxxxxxx"
]
promo_code_idsstring[]

Only return members holding a membership bought with one of these promo codes, prefixed promo_. Unknown IDs match nothing.

[
  "promo_xxxxxxxxxxxx"
]
querystring

Search members by name or username. An exact email address also matches when the credential holds the member:email:read scope.

created_afterstring

Only members who joined after this ISO 8601 timestamp.

created_beforestring

Only members who joined before this ISO 8601 timestamp.

order'created_at' | 'joined_at' | 'last_accessed_at' | 'most_recent_action_at' | 'usd_total_spent'

Sort field. most_recent_action_at places members without one first when ascending and last when descending.

direction'asc' | 'desc'

Sort direction.

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

members listed

Example response

{
  "data": [
    {
      "access_level": "customer",
      "account_id": "biz_xxxxxxxxxxxxxx",
      "created_at": "2026-01-01T12:00:00.000Z",
      "display_name": "Dana Whitfield",
      "email": "marcus@shinetime.example",
      "id": "mber_xxxxxxxxxxxxxx",
      "joined_at": "2026-01-01T12:00:00.000Z",
      "last_accessed_at": "2026-01-01T12:00:00.000Z",
      "most_recent_action": "paid_subscriber",
      "most_recent_action_at": "2026-01-01T12:00:00.000Z",
      "phone_number": "+xxxxxxxxxxx",
      "status": "joined",
      "token_balance": 70.25,
      "usd_total_spent": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "user": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Dana Whitfield",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "danawhitfield"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • 507636677fe9Revision changes
    • info

      added the new optional query request parameter membership_status

    • info

      added the new optional query request parameter most_recent_actions

    • info

      added the new optional query request parameter plan_ids

    • info

      added the new optional query request parameter product_ids

    • info

      added the new optional query request parameter promo_code_ids

    • info

      added the new enum value most_recent_action_at to the query request parameter order

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 16c82685be35Revision changes
    • info

      added the required property // to the response with the status