Search

customer Group Repository V1Get List Get

get

Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN 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 https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Query parameters

searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>

searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>

searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>

searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>

searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>

searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>

searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /V1/customerGroups/search HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "code": "<string>",
      "tax_class_id": "<integer>",
      "id": "<integer>",
      "tax_class_name": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "code": "<string>",
      "tax_class_id": "<integer>",
      "id": "<integer>",
      "tax_class_name": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "tempor sit esse aute",
            "value": "quis esse aute",
            "condition_type": "Duis dolor"
          },
          {
            "field": "ea exercitation voluptate nisi",
            "value": "Duis quis in",
            "condition_type": "nulla commodo eu minim "
          }
        ]
      },
      {
        "filters": [
          {
            "field": "occaecat Ut nulla dolore",
            "value": "voluptate pariatur",
            "condition_type": "anim Lorem in nostrud"
          },
          {
            "field": "proident nisi et dolor",
            "value": "qui occaecat non",
            "condition_type": "dolore cupidatat esse"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "dolore",
        "direction": "ipsum consequat ea aliquip deserunt"
      },
      {
        "field": "et culpa",
        "direction": "labore sit"
      }
    ],
    "page_size": 20429157,
    "current_page": 86564793
  },
  "total_count": -96851788
}