customerSegments/search

Retrieve customer segments that match a specified criteria.

Request

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

get/V1/customerSegments/search

Response samples

200
401
500
default

{"items": [{"apply_to": 0,
"associated_websites": [{"code": "string",
"default_group_id": 0,
"extension_attributes": { },
"id": 0,
"name": "string"
}
],
"description": "string",
"id": 0,
"is_active": 0,
"name": "string",
"number_of_customers": 0,
"uid": "string"
}
],
"search_criteria": {"current_page": 0,
"filter_groups": [{"filters": [{"condition_type": "string",
"field": "string",
"value": "string"
}
]
}
],
"page_size": 0,
"sort_orders": [{"direction": "string",
"field": "string"
}
]
},
"total_count": 0
}

➔ Next to customers