Get Rule

Retrieve details of a specific moderation rule by its ID.

GET /moderation/rules/{ruleId}

Get Rule

cURL

curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/moderation/rules/{ruleId} \
  --header 'apikey: <api-key>'

200

{
  "data": {
    "id": "profanity-list",
    "name": "Profane Words",
    "category": "word",
    "isCSV": false,
    "searchTerms": [
      "fuck",
      "damn",
      "shit",
      "cunt",
      "nigga",
      "nigger",
      "wanker",
      "cunt",
      "fag",
      "shithead",
      "jizz",
      "hellbitch",
      "retard",
      "cocksucker",
      "cock",
      "kill",
      "kike",
      "twat",
      "bastard",
      "death",
      "asshole",
      "wop",
      "scumbag",
      "penis",
      "murder",
      "dick",
      "gook",
      "vagina",
      "rape",
      "bastard",
      "spic",
      "spunk",
      "beat"
    ],
    "createdAt": 1718354412,
    "updatedAt": 1718354412,
    "revisionId": "253157108b5294c4_profanity-list_1",
    "active": true,
    "default": true
  }
}

Authorizations

apikey · string · header · required

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

Path Parameters

ruleId · string · required

Rule ID

Response

200 - application/json

Get Rule

data · object

Show child attributes