List

List

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

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/groups"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.api-{region}.cometchat.io/v3/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{appId}.api-{region}.cometchat.io/v3/groups")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "guid": "project-group",
      "name": "Project Group",
      "description": "project related discussions between members",
      "icon": "http://placehold.it/120x120&text=image1",
      "type": "public",
      "scope": "admin",
      "membersCount": 1,
      "joinedAt": 1638440784,
      "conversationId": "group_project-group",
      "hasJoined": true,
      "createdAt": 1638440784,
      "owner": "superhero4",
      "tags": [
        "friends",
        "project"
      ]
    },
    {
      "guid": "project-group-2",
      "name": "Project Group 2",
      "description": "project related discussions between members",
      "icon": "http://placehold.it/120x120&text=image1",
      "type": "public",
      "scope": "admin",
      "membersCount": 1,
      "joinedAt": 1638440784,
      "conversationId": "group_project-group",
      "hasJoined": true,
      "createdAt": 1638440784,
      "owner": "superhero4",
      "tags": [
        "friends",
        "project"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 5,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    },
    "cursor": {
      "updatedAt": 1638354799,
      "affix": "prepend"
    }
  }
}

GET

groups

List

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

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/groups"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.api-{region}.cometchat.io/v3/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{appId}.api-{region}.cometchat.io/v3/groups")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "guid": "project-group",
      "name": "Project Group",
      "description": "project related discussions between members",
      "icon": "http://placehold.it/120x120&text=image1",
      "type": "public",
      "scope": "admin",
      "membersCount": 1,
      "joinedAt": 1638440784,
      "conversationId": "group_project-group",
      "hasJoined": true,
      "createdAt": 1638440784,
      "owner": "superhero4",
      "tags": [
        "friends",
        "project"
      ]
    },
    {
      "guid": "project-group-2",
      "name": "Project Group 2",
      "description": "project related discussions between members",
      "icon": "http://placehold.it/120x120&text=image1",
      "type": "public",
      "scope": "admin",
      "membersCount": 1,
      "joinedAt": 1638440784,
      "conversationId": "group_project-group",
      "hasJoined": true,
      "createdAt": 1638440784,
      "owner": "superhero4",
      "tags": [
        "friends",
        "project"
      ]
    }
  ],
  "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).

Headers

onBehalfOf

string

UID of the user on whose behalf the action is performed.

Query Parameters

searchKey

string

Searches for given keyword in group's list (either GUID, name or email).

searchIn

string[]

Searches for specified keyword in name,GUID or both.

sortBy

enum<string>

Sorts the group list by either Name,Guid or Created at . Available values: name, guid, createdAt

Available options:

name,

guid,

createdAt

sortOrder

enum<string>

Sorts the group list in ascending or descending order. Available values: asc, desc

Available options:

asc,

desc

perPage

integer

default:100

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

affix

enum<string>

Determines whether to fetch the groups either before or after createdAt/updatedAt timestamp. Possible values are append(after) and prepend(before).

Available options:

append,

prepend

updatedAt

integer

Fetches the groups list after a particular updatedAt timestamp.

withTags

boolean

Includes those groups that have tags.

Response

200 - application/json

A list of groups

data

any[]

Chat APIs

Management APIs (Multi-Tenancy)

Authorizations

Headers

Query Parameters

Response