> ## Documentation Index
> Fetch the complete documentation index at: https://cometchat-22654f5b-docs-rn-guide-message-privately.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve Users
> Retrieve Users — CometChat documentation.
## Retrieve Logged In User Details
You can get the details of the logged-in user using the `getLoggedInUser()` method. This method can also be used to check if the user is logged in or not. If the method returns `Promise` with reject callback, it indicates that the user is not logged in and you need to log the user into CometChat SDK.
```javascript theme={null}
var user = CometChat.getLoggedinUser().then(
user => {
console.log("user details:", { user });
}, error => {
console.log("error getting details:", { error });
}
);
```
This method will return a `User` object containing all the information related to the logged-in user.
## Retrieve List of Users
In order to fetch the list of users, you can use the `UsersRequest` class. To use this class i.e to create an object of the `UsersRequest` class, you need to use the `UsersRequestBuilder` class. The `UsersRequestBuilder` class allows you to set the parameters based on which the users are to be fetched.
The `UsersRequestBuilder` class allows you to set the below parameters:
### Set Limit
This method sets the limit i.e. the number of users that should be fetched in a single iteration.
```javascript theme={null}
let limit = 30;
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.build();
```
### Set Search Keyword
This method allows you to set the search string based on which the users are to be fetched.
```javascript theme={null}
let limit = 30;
let searchKeyword = "super";
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.setSearchKeyword(searchKeyword)
.build();
```
### Set Status
The status based on which the users are to be fetched. The status parameter can contain one of the below two values:
* CometChat.USER\_STATUS.ONLINE - will return the list of only online users.
* CometChat.USER\_STATUS.OFFLINE - will return the list of only offline users.
If this parameter is not set, will return all the available users.
```javascript theme={null}
let limit = 30;
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.setStatus(CometChat.USER_STATUS.ONLINE)
.build()
```
### Hide Blocked Users
This method is used to determine if the blocked users should be returned as a part of the user list. If set to true, the user list will not contain the users blocked by the logged in user.
```javascript theme={null}
let limit = 30;
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.hideBlockedUsers(true)
.build();
```
### Set Roles
This method allows you to fetch the users based on multiple roles.
```javascript theme={null}
let limit = 30;
let roles = ["default", "dev"];
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.setRoles(roles)
.build();
```
### Friends Only
This property when set to true will return only the friends of the logged-in user.
```javascript theme={null}
let limit = 30;
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.friendsOnly(true)
.build();
```
### Set Tags
This method accepts a list of tags based on which the list of users is to be fetched. The list fetched will only contain the users that have been tagged with the specified tags.
```javascript theme={null}
let limit = 30;
let tags = ["tag1", "tag2"];
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.setTags(tags)
.build();
```
### With Tags
This property when set to true will fetch tags data along with the list of users.
```javascript theme={null}
let limit = 30;
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.withTags(true)
.build();
```
### Set UIDs
This method accepts a list of UIDs based on which the list of users is fetched. A maximum of `25` users can be fetched.
```javascript theme={null}
let limit = 30;
let UIDs = ["cometchat-uid-1", "cometchat-uid-2"];
let usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.setUIDs(UIDs)
.build();
```
Finally, once all the parameters are set to the builder class, you need to call the build() method to get the object of the UsersRequest class.
Once you have the object of the UsersRequest class, you need to call the fetchNext() method. Calling this method will return a list of User objects containing n number of users where n is the limit set in the builder class.
```javascript theme={null}
var limit = 30;
var usersRequest = new CometChat.UsersRequestBuilder()
.setLimit(limit)
.build();
usersRequest.fetchNext().then(
userList => {
console.log("User list received:", userList);
}, error => {
console.log("User list fetching failed with error:", error);
}
);
```
## Retrieve Particular User Details
To get the information of a user, you can use the `getUser()` method.
```javascript theme={null}
let UID = "UID";
CometChat.getUser(UID).then(
user => {
console.log("User details fetched for user:", user);
}, error => {
console.log("User details fetching failed with error:", error);
}
);
```
The `getUser()` method takes the following parameters:
| Parameter | Description |
| --------- | ---------------------------------------------------------- |
| UID | The UID of the user for whom the details are to be fetched |
It returns the `User` object containing the details of the user.