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 a single member type, e.g. customer or rep. To match several types in one request, use the filter[member_type_slug][] array form instead. Send one form or the other, never both; the result of sending both is undefined.

filter[member_type_slug][]
string[]

Restrict to any of several member types, e.g. rep and provider. Repeat the parameter once per slug; a member matches if its type is any of them. To request an explicit empty set, which matches no members, send the bare key filter[member_type_slug][] with no value — most clients serialize a zero-item array as no parameter at all, which reads as an omitted filter and applies no restriction. Send this array form or the scalar filter[member_type_slug], never both; the result of sending both is undefined.

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

filter[metafield][namespace]
string

Namespace of a searchable member metafield. Send with filter[metafield][key] and filter[metafield][value]. For example, ?filter[metafield][namespace]=referral&filter[metafield][key]=codes&filter[metafield][value]=e0d941dcd3.

Maximum string length: 255
filter[metafield][key]
string

Key of a searchable member metafield. Namespace and key matching is case-insensitive.

Maximum string length: 255
filter[metafield][value]
string

Exact, case-insensitive and surrounding-space-insensitive value to match. Any of the first 100 elements of a JSON array can match. Only the first 100 metafields of a member are matched. The member definition must be searchable and the member metafield lookup feature must be enabled; otherwise the request returns 422.

Maximum string length: 255
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[include_discarded]
boolean

When true, soft-discarded members of the company are listed too. Defaults to false.

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