List global pinned conversations

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

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

fetch('https://{appId}.api-{region}.cometchat.io/v3/conversations/pinned', 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/conversations/pinned",
  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/conversations/pinned"

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

}

require 'uri'
require 'net/http'

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

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": [
    {
      "conversationId": "supergroup",
      "conversationType": "group",
      "pinnedBy": "app_system",
      "pinnedAt": 1700210300
    },
    {
      "conversationId": "superhero1_user_superhero2",
      "conversationType": "user",
      "pinnedBy": "app_system",
      "pinnedAt": 1700210299
    }
  ]
}

GET

conversations

pinned

List global pinned conversations

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

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

fetch('https://{appId}.api-{region}.cometchat.io/v3/conversations/pinned', 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/conversations/pinned",
  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/conversations/pinned"

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

}

require 'uri'
require 'net/http'

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

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": [
    {
      "conversationId": "supergroup",
      "conversationType": "group",
      "pinnedBy": "app_system",
      "pinnedAt": 1700210300
    },
    {
      "conversationId": "superhero1_user_superhero2",
      "conversationType": "user",
      "pinnedBy": "app_system",
      "pinnedAt": 1700210299
    }
  ]
}

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).

Response

200 - application/json

Listing the global pinned conversations, in display order

data

object[]

Show child attributes

Chat APIs

Management APIs (Multi-Tenancy)

List global pinned conversations

Authorizations

Response