Skip to main content
Skip to main content

AdminGetCustomersParams

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

constructor


Properties

expandstring
Comma-separated relations that should be expanded in the returned data.
groupsstring[]
Filter customers by the customer's customer groups.
has_accountboolean
Filter customers by whether they have an account.
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

qstring
Search term used to search customers' email, first name, last name.
Was this section helpful?