AdminGetCustomerGroupsParams

Parameters used to filter and configure the pagination of the retrieved customer groups.

Properties

orderstring

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 10

expandstring

Comma-separated relations that should be expanded in the returned data.

idstring | string[] | StringComparisonOperator

IDs to filter customer groups by.

qstring

Search term to search customer groups by their name.

namestring[]

Names to filter customer groups by.

updated_atDateComparisonOperator

Date filters to apply on the customer groups' update_at date.

created_atDateComparisonOperator

Date filters to apply on the customer groups' created_at date.

discount_condition_idstring

Filter customer groups by their associated discount condition's ID.