commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Customer Group → Query CustomerGroups

AI-generated

Summary

Query customer groups in commercetools by applying optional filters such as where conditions, expand paths, sorting, pagination (limit and offset), and whether to include the total count.

Inputs

  • Filters — Optional parameters to filter and paginate the customer groups returned, including 'where' (filter condition), 'expand' (to expand related references), 'sort' (sort order), 'limit' (maximum number of results to return), 'offset' (number of results to skip), and 'withTotal' (whether to include total count of matching results).

Output shape

a list of customer group objects matching the query parameters

The output returns the API response from commercetools as JSON, including the array of customer groups and optionally the total count if requested. Pagination parameters like limit and offset control the result window. Errors are returned as failure objects if 'Continue On Fail' is enabled.

Examples

Example 1: Retrieve up to 10 customer groups sorted by name ascending with total count included.

Set 'Limit' to '10', 'Sort' to 'name asc', and 'With Total' to 'true' in Filters.

Links

Discussion