Skip to main content
GET
List Members
OAuth scope: memberships_readAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-ShopId
string

Query Parameters

page
integer
limit
integer
search_query
string
tier_ids[]
(integer | null)[]
intervals[]
(enum<string> | null)[]
Available options:
Month,
Year
states[]
(enum<string> | null)[]
Available options:
Active,
Expiring,
Former,
PastDue,
None,
FreeTrial
member_ids[]
(integer | null)[]
gifted_by_others
boolean

Response

members
Member · object[]
required
pagination
Pagination · object
required