List

List members of a CometChat group by GUID with REST API to retrieve users, scopes, and membership details.

GET /groups/{guid}/members

List

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members \
  --header 'apikey: <api-key>'

200

{
  "data": [
    {
      "uid": "cometchat-uid-2",
      "name": "George Alan",
      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
      "status": "offline",
      "role": "default",
      "scope": "participant",
      "joinedAt": 1638360106,
      "createdAt": 1629869270,
      "updatedAt": 1630308676,
      "conversationId": "cometchat-uid-2_user_cometchat-uid-4"
    },
    {
      "uid": "cometchat-uid-3",
      "name": "George Alan",
      "link": "https://data-us.cometchat.io/assets",
      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
      "metadata": {
        "contactNumber": "0123456789"
      },
      "status": "offline",
      "role": "default",
      "scope": "participant",
      "joinedAt": 1638360106,
      "createdAt": 1629869270,
      "updatedAt": 1638351060,
      "conversationId": "cometchat-uid-3_user_cometchat-uid-4"
    },
    {
      "uid": "cometchat-uid-5",
      "name": "John Paul",
      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-5.webp",
      "status": "offline",
      "role": "default",
      "scope": "moderator",
      "joinedAt": 1638360106,
      "createdAt": 1629869270,
      "conversationId": "cometchat-uid-4_user_cometchat-uid-5"
    },
    {
      "uid": "cometchat-uid-4",
      "name": "Susan Marie",
      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-4.webp",
      "status": "offline",
      "role": "default",
      "scope": "admin",
      "joinedAt": 1638359534,
      "createdAt": 1629869270
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 5,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  },
  "cursor": {
    "updatedAt": 1638354799,
    "affix": "prepend"
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

guid · string · required

A GUID of a group.

Query Parameters

perPage · integer · default: 100

Number of users to be fetched in a request. The default value is 100 and the maximum value is 1000.

status · enum<string>

Group members list can be fetched depending on the user status. (available,offline). User status filter.

Available options: available, offline

page · integer · default: 1

Page Number.

scopes · any[]

Fetches group members based on multiple scope.

Response

200 - application/json

Create Group Members

data · array

meta · object