Retrieve Group Members

Fetch and paginate group members using the CometChat JavaScript SDK.

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

Filters members by a search string.

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(); ```
</Tab>

</Tabs>

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.

<Tabs>
<Tab title="TypeScript">
```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.

---

Next Steps

Add Members

Add users to a group programmatically

Kick & Ban Members

Remove or ban members from a group