listAndCount - Customer Module Reference
This documentation provides a reference to the listAndCount
method. This belongs to the Customer Module.
This method retrieves a paginated list of customers along with the total count of available customers satisfying the provided filters.
Example
To retrieve a list of customers using their IDs:
To specify relations that should be retrieved within the customers:
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
FilterableCustomerPropsThe filters to apply on the retrieved customers.
filters
FilterableCustomerPropsconfig
FindConfig<CustomerDTO>The configurations determining how the customer is retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a customer.
config
FindConfig<CustomerDTO>select
or relations
, accept the
attributes or relations associated with a customer.Returns
The list of customers along with their total count.
Was this section helpful?