CustomerSegments
List CustomerSegments
Returns a paginated list of CustomerSegments for the given site.
get/shop/customers/customer-segments
Query parameters
site_idstring uuid required
Filters segments that belong to the given site ID.
querystring
Filters segments whose name contains the given value.
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
The customer segments were successfully retrieved.
Example response
{
"data": [
{
"name": "Premium Members"
}
],
"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.