GET
/
roles
/
{role}
Get
curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/roles/{role} \
  --header 'apikey: <api-key>'
{
  "data": {
    "role": "manager",
    "name": "manager",
    "description": "This role gives an update access",
    "metadata": {
      "email": "managers@gmail.com"
    },
    "settings": {
      "listUsers": "all",
      "sendMessagesTo": "friendsOnly"
    },
    "createdAt": 1638343994
  }
}

Authorizations

​
apikey
string
header
required

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

Path Parameters

​
role
string
required

A role to get.

Response

200 - application/json

Fetched the role

The response is of type object.