customer Group Repository V1Get List Get
GET {{baseUrl}}/V1/customerGroups/search?searchCriteria[filterGroups][][filters][][field]=<string>&searchCriteria[filterGroups][][filters][][value]=<string>&searchCriteria[filterGroups][][filters][][conditionType]=<string>&searchCriteria[sortOrders][][field]=<string>&searchCriteria[sortOrders][][direction]=<string>&searchCriteria[pageSize]=<integer>&searchCriteria[currentPage]=<integer>
Retrieve customer groups. The list of groups can be filtered to exclude the NOTLOGGEDIN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
searchCriteria[filterGroups][][filters][][field] | string | Field | |
searchCriteria[filterGroups][][filters][][value] | string | Value | |
searchCriteria[filterGroups][][filters][][conditionType] | string | Condition type | |
searchCriteria[sortOrders][][field] | string | Sorting field. | |
searchCriteria[sortOrders][][direction] | string | Sorting direction. | |
searchCriteria[pageSize] | string | Page size. | |
searchCriteria[currentPage] | string | Current page. |
RESPONSES
status: OK
""