AdminGetCustomersParams

Parameters used to filter and configure the pagination of the retrieved customers.

Properties

limitnumberRequired

Limit the number of items returned in the list.

Default: 50

offsetnumberRequired

The number of items to skip when retrieving a list.

Default: 0

expandstring

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

fieldsstring

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

qstring

Search term used to search customers' email, first name, last name.

has_accountboolean

Filter customers by whether they have an account.

groupsstring[]

Filter customers by the customer's customer groups.

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 -.

created_atDateComparisonOperator

Date filters to apply on the customers' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the customers' updated_at date.