Retrieve Group Members

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

AI Integration Quick Reference

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

// Filter by scope
const request = new CometChat.GroupMembersRequestBuilder("GUID")
  .setLimit(30).setScopes(["admin", "moderator"]).build();

// Search members
const request = new CometChat.GroupMembersRequestBuilder("GUID")
  .setLimit(30).setSearchKeyword("john").build();

Retrieve the List of Group Members

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

Set Limit

Sets the number of members to fetch per request.

Set Limit

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

Filters members by a search string.

Set Search Keyword

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

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

Set Scopes

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

Set Status

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.

Set Status

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

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

Once configured, call build() to create the request, then fetchNext() to retrieve members.

Group Members Request

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

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

The fetchNext() method returns an array of GroupMember objects. GroupMember extends User and adds group-specific fields. Access the response data using getter methods:

Field	Getter	Return Type	Description
uid	getUid()	string	Unique user ID
name	getName()	string	Display name of the member
scope	getScope()	string	Scope in the group ("admin", "moderator", or "participant")
joinedAt	getJoinedAt()	number	Timestamp when the member joined the group
guid	getGuid()	string	GUID of the group this member belongs to

---

Next Steps

Add Members

Add users to a group programmatically

Kick & Ban Members

Remove or ban members from a group