Skip to main content
GET
List members

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[cursor]
string

Cursor token from the previous response page.

page[limit]
integer

Number of members to return.

Required range: 1 <= x <= 100
sort
enum<string>

Sort order. Prefix with - to reverse.

Available options:
created_at,
-created_at,
name,
-name
filter[active]
boolean

Restrict to active (true) or inactive (false) members.

filter[member_type_slug]
string

Restrict to one member type, e.g. customer or rep.

Free-text match across name, email, and username.

filter[country_iso]
string

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Za-z]{2}$
filter[external_id]
string

The member's external id, as set by an integration.

filter[sponsor_member_id]
string

Restrict to members sponsored by this member.

filter[rank_id]
integer

Restrict to members holding this rank.

filter[orders_count_min]
integer

Minimum lifetime order count.

filter[orders_count_max]
integer

Maximum lifetime order count.

filter[total_spent_min]
number

Minimum lifetime spend, in the company base currency.

filter[total_spent_max]
number

Maximum lifetime spend, in the company base currency.

filter[created_at_from]
string<date-time>

Only members created at or after this time.

filter[created_at_to]
string<date-time>

Only members created at or before this time.

filter[updated_at_from]
string<date-time>

Only members updated at or after this time.

filter[updated_at_to]
string<date-time>

Only members updated at or before this time.

Response

Success

members
object[]
required
meta
object
required
status
integer