Retrieve Group Members

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 scopeRequest = new CometChat.GroupMembersRequestBuilder("GUID")
  .setLimit(30).setScopes(["admin", "moderator"]).build();

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

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
JavaScript

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

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

Set Search Keyword

Filters members by a search string.

TypeScript
JavaScript

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

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
JavaScript

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

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

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
JavaScript

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

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
JavaScript

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

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.

Retrieve the List of Group Members

Set Limit

Set Search Keyword

Set Scopes

Set Status

Next Steps

Add Members

Kick & Ban Members

​Retrieve the List of Group Members

​Set Limit

​Set Search Keyword

​Set Scopes

​Set Status

​Next Steps

Add Members

Kick & Ban Members

Retrieve the List of Group Members

Set Limit

Set Search Keyword

Set Scopes

Set Status

Next Steps