CustomerSegmentMembers
List CustomerSegmentMembers
Returns a paginated list of members belonging to the given CustomerSegment.
get/shop/customers/customer-segments/{customerSegmentId}/members
Query parameters
querystring
Filters members whose customer name or email contains the given value.
subscribedboolean
When true, only subscribed members are returned. When false, only unsubscribed members are returned.
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
The segment members were successfully retrieved.
Example response
{
"data": [
{
"customer": {
"email": "janedoe@example.com",
"first_name": "Jane",
"full_name": "Jane Doe",
"last_name": "Doe",
"phone": "+447900000000"
}
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.