Skip to main content
GET
/
roles
/
{role}
/
permissions
List Role Permissions
curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/roles/{role}/permissions \
  --header 'apikey: <api-key>'
import requests

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

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/roles/{role}/permissions', 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/roles/{role}/permissions",
  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/roles/{role}/permissions"

	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/roles/{role}/permissions")
  .header("apikey", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

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

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": [
    {
      "id": "createGroup",
      "type": "role",
      "title": "Allows/Denies creating groups",
      "description": "Allows/Denies creating groups",
      "dataType": "string",
      "availableValues": [
        "allow",
        "deny"
      ],
      "defaultValue": "allow",
      "createdAt": 1765962204,
      "updatedAt": 1765962204
    },
    {
      "id": "sendMessage",
      "type": "role",
      "title": "Allows/Denies sending messages",
      "description": "Allows/Denies sending messages",
      "dataType": "string",
      "availableValues": [
        "allow",
        "deny"
      ],
      "defaultValue": "allow",
      "createdAt": 1765962204,
      "updatedAt": 1765962204
    },
    {
      "id": "sendMessage.allowedMessageTypes",
      "type": "role",
      "title": "Allows sending messages of the specified types",
      "description": "Allows sending messages of the specified types",
      "dataType": "stringArray",
      "availableValues": [
        "text",
        "image",
        "audio",
        "video",
        "file"
      ],
      "createdAt": 1765962204,
      "updatedAt": 1765962204,
      "defaultValue": []
    }
  ],
  "meta": {
    "pagination": {
      "total": 28,
      "count": 28,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  }
}
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

​
role
string
required

The role identifier to update permissions for

Example:

"default"

Response

200 - application/json

Lists role permissions

​
data
object[]
​
meta
object