Retrieve Group Members

Fetch and filter group members by scope, status, and search keyword using the CometChat React Native SDK with pagination support.

AI Integration Quick Reference

Field	Value
Package	@cometchat/chat-sdk-react-native
Import	import { CometChat } from "@cometchat/chat-sdk-react-native";
Key Classes	GroupMember (extends User), GroupMembersRequest, GroupMembersRequestBuilder, CometChatException
Key Methods	fetchNext(), fetchPrevious() — build the request via GroupMembersRequestBuilder
Request Builder	new CometChat.GroupMembersRequestBuilder(GUID) — GUID goes to the constructor; chain .setLimit(), .setSearchKeyword(), .setScopes(), .setStatus(), then .build()
Primary output	Promise<CometChat.GroupMember[]> — rejects with CometChatException. Read a member’s role with getScope() (admin / moderator / participant)
Prerequisites	SDK initialized via CometChat.init(), user logged in via CometChat.login(); a valid GUID for a group the logged-in user is a member of
Related	Retrieve Groups, Add Members, Kick & Ban Members
Constraints	Pass the GUID to the builder’s constructor, not to fetchNext(). Banned members do not appear here — use BannedMembersRequest.
Full reference	GroupMember · User · Group · CometChatException

Fetch the members of a group with filtering by scope, online status, and search keyword. Results are returned as GroupMember objects, which extend User with group-specific fields like scope.

​

Retrieve the List of Group Members

Use GroupMembersRequestBuilder to fetch members of a Group. The GUID must be specified in the constructor.

Fetching using this builder will return GroupMember objects. GroupMember extends User and adds group-specific fields.

​

Set Limit

Sets the number of members to fetch per request.

TypeScript

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

JavaScript

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

​

Set Search Keyword

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();

JavaScript

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

​

Set Scopes

Filters members by one or more scopes (admin, moderator, participant).

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();

JavaScript

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

Relevant fields to access on returned members:

Field	Getter	Return Type	Description
scope	getScope()	string	Scope of the member in the group ("admin", "moderator", or "participant")

​

Set Status

With offline support on, this filter is answered by the server only; the cached page is empty.

Filters members by online status:

Value	Description
CometChat.USER_STATUS.ONLINE	Only online members
CometChat.USER_STATUS.OFFLINE	Only offline members

If not set, returns all members regardless of status.

TypeScript

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

JavaScript

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

After configuring the builder, call build() to create the request, then fetchNext() to retrieve members. Call fetchNext() repeatedly on the same instance to paginate.

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);
  }
);

JavaScript

let GUID = "GUID";
let limit = 30;
let 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);
}
);

The fetchNext() method returns an array of GroupMember objects. GroupMember extends User and adds group-specific fields.

​

Offline Behaviour

With offline support enabled, passing a GroupMemberFetchListener to GroupMembersRequest.fetchNext() calls onCachedGroupMembers first with the pages the server last returned for this exact request, replayed from the device (empty when nothing was recorded). Then onServerGroupMembers delivers the live page to reconcile by uid. Offline, the read ends with onError (FAILED_TO_FETCH) after the cached page, and the Promise rejects. A request that uses a server-only filter records nothing, so its cached page is always empty. See Show Cached Data.

Builder method	Offline
setLimit	Cached
setScopes	Cached
setSearchKeyword	Server only, cached page is empty
setStatus	Server only, cached page is empty

---

​

Next Steps

Add Members

Add users to a group programmatically

Kick & Ban Members

Remove or ban members from a group

Change Member Scope

Update member roles within a group

Retrieve Groups

Fetch group lists and group details