listAndCountCustomerGroups - Customer Module Reference
This documentation provides a reference to the listAndCountCustomerGroups
method. This belongs to the Customer Module.
This method retrieves a paginated list of customer groups along with the total count of available customer groups satisfying the provided filters.
Example
To retrieve a list of customer groups using their IDs:
To specify relations that should be retrieved within the customer groups:
By default, only the first 15
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
Parameters
filters
FilterableCustomerGroupPropsThe filters to apply on the retrieved customer groups.
filters
FilterableCustomerGroupPropsconfig
FindConfig<CustomerGroupDTO>The configurations determining how the customer group is retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a customer group.
config
FindConfig<CustomerGroupDTO>select
or relations
, accept the
attributes or relations associated with a customer group.Returns
The list of customer groups along with their total count.
Was this section helpful?