Returns list of Loyalty Club members.
Query Parameters
Parameter | Type | Required? | Default | Description |
---|
per_page | integer | no | 1000 | Number of results to be returned per request (1000 is the maximum) |
page_no | integer | no | 1 | Number of results page |
ids | integer[] | no | null | When present, only members with given IDs will be returned |
properties.<property_name> | string[] | no | null | When present, only members with given properties will be returned. A property must be enabled for querying in the Loyalty Club configuration before it can be used here. Please contact us if you need this feature. |
store_ids | integer[] | no | null | When present, only members having at least one of given stores will be returned |
search | string | no | null | When present, only members matching the query will be returned |
sort_by | string[] | no | null | See: Sorting params |
sort_directions | string[] | no | null | See: Sorting params |
Response Body
Key | Type | Description |
---|
members | Member[] | Array of Members |
pagination_info | Object | Pagination object |
Error Responses
Status | Reason |
---|
422 | :per_page param exceeds the limit |
Example
curl "https://api.mpc.placewise.com/v3/infinity-mall/members?per_page=100&page_no=1&ids[]=1&ids[]=2" \
-H 'content-type: application/json' \
-H 'x-client-authorization: B7t9U9tsoWsGhrv2ouUoSqpM' \
-H 'x-product-name: default' \
-H 'x-user-agent: CURL manual test'
When successful, returns object containing members and PaginationInfo
{
"members": [], // List of members - see 'Member model'
"pagination_info": {} // Pagination info - see 'Pagination info"
}
Other example queries
/members?properties[gender]=man&properties[language][]=en&properties[language][]=pl
- returns members with gender="man" AND language IN ("en", "pl")
/members?ids[]=1&ids[]=2
- returns members with id IN (1, 2)