Retrieve Group Members

Fetch and search members of a group

Quick Reference for AI Agents & Developers

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

// Search members
const membersRequest = new CometChat.GroupMembersRequestBuilder("group_guid")
  .setSearchKeyword("john")
  .build();

// Filter by scope (admin, moderator, participant)
const membersRequest = new CometChat.GroupMembersRequestBuilder("group_guid")
  .setScopes(["admin", "moderator"])
  .build();

// Filter online members
const membersRequest = new CometChat.GroupMembersRequestBuilder("group_guid")
  .setStatus(CometChat.USER_STATUS.ONLINE)
  .build();

// Member properties: uid, name, avatar, scope, status, joinedAt

Retrieve the list of members in a group with various filtering options.

Availability: SDK, API, UI Kits

---

Fetch Group Members

Use GroupMembersRequestBuilder to fetch members:

JavaScript

const GUID = "group-123";
const limit = 30;

const membersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(limit)
  .build();

membersRequest.fetchNext().then(
  (members) => {
    members.forEach((member) => {
      console.log("Name:", member.getName());
      console.log("Scope:", member.getScope());
    });
  },
  (error) => console.log("Failed:", error)
);

TypeScript

const GUID: string = "group-123";
const limit: number = 30;

const membersRequest: CometChat.GroupMembersRequest = 
  new CometChat.GroupMembersRequestBuilder(GUID)
    .setLimit(limit)
    .build();

membersRequest.fetchNext().then(
  (members: CometChat.GroupMember[]) => {
    members.forEach((member) => {
      console.log("Name:", member.getName());
      console.log("Scope:", member.getScope());
    });
  },
  (error: CometChat.CometChatException) => console.log("Failed:", error)
);

Async/Await

const getGroupMembers = async () => {
  try {
    const GUID = "group-123";
    const limit = 30;

    const membersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
      .setLimit(limit)
      .build();

    const members = await membersRequest.fetchNext();
    members.forEach((member) => {
      console.log("Name:", member.getName());
      console.log("Scope:", member.getScope());
    });
  } catch (error) {
    console.log("Failed:", error);
  }
};

Builder Options

Method	Description
setLimit(limit)	Number of members per request (max 100)
setSearchKeyword(keyword)	Search members by name
setScopes(scopes)	Filter by member scopes
setStatus(status)	Filter by online/offline status

---

Search Members

const membersRequest = new CometChat.GroupMembersRequestBuilder("group-123")
  .setLimit(30)
  .setSearchKeyword("john")
  .build();

membersRequest.fetchNext().then(
  (members) => console.log("Search results:", members),
  (error) => console.log("Failed:", error)
);

---

Filter by Scope

Get only admins and moderators:

const membersRequest = new CometChat.GroupMembersRequestBuilder("group-123")
  .setLimit(30)
  .setScopes(["admin", "moderator"])
  .build();

membersRequest.fetchNext().then(
  (members) => console.log("Admins and moderators:", members),
  (error) => console.log("Failed:", error)
);

---

Filter by Status

Get only online members:

const membersRequest = new CometChat.GroupMembersRequestBuilder("group-123")
  .setLimit(30)
  .setStatus(CometChat.USER_STATUS.ONLINE)
  .build();

membersRequest.fetchNext().then(
  (members) => console.log("Online members:", members),
  (error) => console.log("Failed:", error)
);

---

Member Properties

Property	Description
uid	User’s unique identifier
name	Display name
avatar	Profile picture URL
scope	ADMIN, MODERATOR, or PARTICIPANT
status	online or offline
joinedAt	When user joined the group

---

Next Steps

Add Members

Add members to a group

Kick/Ban Members

Remove members from a group

Change Scope

Update member permissions

Transfer Ownership

Transfer group ownership