customerGroups

Query

Retrieves a paged list of customers with optional filtering, sorting, and full-text search.

Arguments

after String: Returns the elements in the list that come after the specified cursor.
before String: Returns the elements in the list that come before the specified cursor.
first Int: Returns the first n elements from the list.
last Int: Returns the last n elements from the list.
query String: A filter expression made up of terms, boolean operators, modifiers, and comparators. Combine one or more filters in a single query.
Available filters4
defaultstring
Searches indexed customer-group names and descriptions. Every term must match.
Examplewholesale customers
idID
Matches a customer group by its unique identifier.
Exampleid:cusgrp_...
namestring
Matches the customer group name.
Examplename:"Wholesale customers"
descriptionstring
Matches the customer group description.
Exampledescription:wholesale*
Query language guide
sortDirection SortDirection: Sort direction (ascending or descending).
Possible enum values
ASC
Orders values from lowest to highest or alphabetically from A to Z.
DESC
Orders values from highest to lowest or alphabetically from Z to A.
sortKey CustomerGroupSortKeys: Field key to sort by.
Possible enum values
ID
Sort by customer group `ID`.
NAME
Sort by the `name` value.