Sign in
Members

List Members

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

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"
]
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' | 'usd_total_spent'

Sort field.

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",
      "id": "mber_xxxxxxxxxxxxxx",
      "joined_at": "2026-01-01T12:00:00.000Z",
      "last_accessed_at": "2026-01-01T12:00:00.000Z",
      "phone_number": "+xxxxxxxxxxx",
      "status": "joined",
      "user": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Dana Whitfield",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "danawhitfield"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes