listUsers - User Module Reference

This documentation provides a reference to the listUsers method. This belongs to the User Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves a paginated list of users based on optional filters and configuration.

Example#

To retrieve a list of users using their IDs:

Code
1const users = await userModuleService.listUsers({2  id: ["user_123", "user_321"]3})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

Code
1const users = await userModuleService.listUsers(2  {3    id: ["user_123", "user_321"]4  },5  {6    take: 20,7    skip: 28  }9)

Parameters#

filtersFilterableUserPropsOptional

The filters to apply on the retrieved users.

configFindConfig<UserDTO>Optional

The configurations determining how the user is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a user.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<UserDTO[]>

The list of users.

Was this page helpful?