v8

OpenAPI 3.1.02026-08-033623795.0 MB
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.

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 members to return from the start of the window.

afterstring

Cursor to paginate forwards from.

lastinteger

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

beforestring

Cursor to paginate backwards from.

Response

members listed

Example response

{
  "data": [
    {
      "access_level": "no_access",
      "status": "joined"
    }
  ]
}