GET
/
api
/
v2
/
roles
get all roles
curl --request GET \
  --url https://apix.us.amity.co/api/v2/roles \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "data": {
    "moderatonSettings": [
      {
        "maxRepetition": 123,
        "maxRepetitionTimeout": 123,
        "blacklistMuteTimeout": 123,
        "whitelistMuteTimeout": 123,
        "maxRepetitionMuteTimeout": 123,
        "enableImageModeration": true,
        "imageModeration": {
          "nudity": 123,
          "suggestive": 123,
          "violence": 123,
          "disturbing": 123
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "roles": [
      {
        "permissions": [
          "<string>"
        ],
        "publicId": "<string>"
      }
    ]
  }
}

Authorizations

X-API-Key
string
header
required

Headers

Authorization
string
required
Content-Type
string
required

Response

200
application/json

Roles information.

The response is of type object.