Retrieve Group Members

Fetch group member lists with filtering by scope, search, and pagination using the CometChat React Native SDK.

Quick Reference - Fetch group members:

const request = new CometChat.GroupMembersRequestBuilder("GUID")
  .setLimit(30)
  .build();
const members = await request.fetchNext();

Available via: SDK | REST API | UI Kits

Retrieve the List of Group Members

In order to fetch the list of groups members for a group, you can use the GroupMembersRequest class. To use this class i.e to create an object of the GroupMembersRequest class, you need to use the GroupMembersRequestBuilder class. The GroupMembersRequestBuilder class allows you to set the parameters based on which the groups are to be fetched.

The GroupMembersRequestBuilder class allows you to set the below parameters:

The GUID of the group for which the members are to be fetched must be specified in the constructor of the GroupMembersRequestBuilder class.

Set Limit

This method sets the limit i.e. the number of members that should be fetched in a single iteration.

JavaScript

let GUID = "GUID";
let limit = 30;
let groupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  												.setLimit(limit)
  												.build();

TypeScript

let GUID: string = "GUID";
let limit: number = 30;
let groupMembersRequest: CometChat.GroupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(limit)
  .build();

Set Search Keyword

This method allows you to set the search string based on which the group members are to be fetched.

JavaScript

let GUID = "GUID";
let limit = 30;
let searchKeyword = "super";
let groupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  												.setLimit(limit)
  												.setSearchKeyword(searchKeyword)
  												.build();   

TypeScript

let GUID: string = "GUID";
let limit: number = 30;
let searchKeyword: string = "super";
let groupMembersRequest: CometChat.GroupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(limit)
  .setSearchKeyword(searchKeyword)
  .build();

Set Scopes

This method allows you to fetch group members based on multiple scopes.

JavaScript

let GUID = "GUID";
let limit = 30;
let scopes = ["admin", "moderator"];
let groupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  												.setLimit(limit)
  												.setScopes(scopes)
  												.build();

TypeScript

let GUID: string = "GUID";
let limit: number = 30;
let scopes: Array<String> = ["admin", "moderator"];
let groupMembersRequest: CometChat.GroupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(limit)
  .setScopes(scopes)
  .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 GroupMembersRequest class.

Once you have the object of the GroupMembersRequest class, you need to call the fetchNext() method. Calling this method will return a list of GroupMember objects containing n number of members where n is the limit set in the builder class.

JavaScript

let GUID = "GUID";
let limit = 30;
lett groupMemberRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  												.setLimit(limit)
  												.build();

groupMemberRequest.fetchNext().then(
groupMembers => {
  console.log("Group Member list fetched successfully:", groupMembers);
}, error => {
  console.log("Group Member list fetching failed with exception:", error);
}
);

TypeScript

let GUID: string = "GUID";
let limit: number = 30;
let groupMembersRequest: CometChat.GroupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(limit)
  .build();

groupMembersRequest.fetchNext().then(
  (groupMembers: CometChat.GroupMember[]) => {
      console.log("Group Member list fetched successfully:", groupMembers);
  }, (error: CometChat.CometChatException) => {
      console.log("Group Member list fetching failed with exception:", error);
  }
);

Best Practices

Use pagination for large groups

Always use fetchNext() with a reasonable setLimit() value (e.g., 20-30). For groups with many members, paginate through results rather than fetching all at once.

Reuse the same request instance for pagination

The GroupMembersRequest object maintains an internal cursor. Creating a new instance resets the cursor. Reuse the same instance across fetchNext() calls.

Filter by scope for admin views

Use setScopes() to fetch only admins or moderators when building admin management UIs, rather than fetching all members and filtering client-side.

Troubleshooting

fetchNext returns empty list

Verify the GUID is correct and the logged-in user is a member of the group. Non-members cannot fetch the member list of private groups.

Same members returned on each fetchNext call

Ensure you’re reusing the same GroupMembersRequest instance. Creating a new builder resets the pagination cursor.

---

Next Steps

Add Members

Add new members to a group

Kick/Ban Members

Kick, ban, and unban group members

Change Member Scope

Update member roles within a group

Retrieve Groups

Fetch group lists and group details