> ## Documentation Index
> Fetch the complete documentation index at: https://cometchat-013b37f0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Rules

> Retrieve a list of all moderation rules.



## OpenAPI

````yaml get /apps/{appId}/moderation/rules
openapi: 3.0.0
info:
  title: Management APIs (Multi-Tenancy)
  description: Create and manage apps on-the-fly using our app management APIs
  version: '1.0'
servers:
  - url: https://apimgmt.cometchat.io
security: []
tags:
  - name: App
    description: The Rest collection for app.
  - name: Extensions
    description: The REST collections for extensions.
  - name: Extensions
    description: The REST collections for Chat widgets.
  - name: Extensions
    description: The REST collections for Giphy extension.
  - name: Extensions
    description: The REST collections for XSS Filter extension.
  - name: Extensions
    description: The REST collections for Image Moderation extension.
  - name: Extensions
    description: The REST collections for Report user extension.
  - name: Extensions
    description: The REST collections for Report message extension.
  - name: Extensions
    description: The REST collections for Sentiment analysis extension.
  - name: Extensions
    description: The REST collections for Voice transcription extension.
  - name: Extensions
    description: The REST collections for Stipop extension.
  - name: Extensions
    description: The REST collections for TinyURL extension.
  - name: Extensions
    description: The REST collections for Intercom extension.
  - name: Extensions
    description: The REST collections for Bitly extension.
  - name: Extensions
    description: The REST collections for Rich media preview extension.
  - name: Extensions
    description: The REST collections for Virus Malware Scanner extension.
  - name: Extensions
    description: The REST collections for Video Broadcasting extension.
  - name: Extensions
    description: The REST collections for Tenor gifs extension.
  - name: Extensions
    description: The REST collections for End-to-end encryption extension.
  - name: Extensions
    description: The REST collections for In-flight message moderation extension.
  - name: Extensions
    description: The REST collections for Stickers extension.
  - name: Extensions
    description: The REST collections for Data masking extension.
  - name: Extensions
    description: The REST collections for Email replies extension.
  - name: Extensions
    description: The REST collections for SMS Notification extension.
  - name: Extensions
    description: The REST collections for Push notification extension.
  - name: Extensions
    description: The REST collections for Chatwoot extension.
  - name: Extensions
    description: The REST collections for Message shortcuts extension.
  - name: Extensions
    description: The REST collections for Email Notification extension.
  - name: Team Management
    description: The REST collections for team management.
  - name: Settings
    description: The REST collections for Settings.
  - name: Extensions
    description: The REST collections for Profanity-filter extension.
  - name: Webhooks
    description: The REST collections for Webhooks.
  - name: Moderation
    description: The REST collections for Moderations.
paths:
  /apps/{appId}/moderation/rules:
    get:
      tags:
        - Moderation
      summary: List Rules
      description: Retrieve a list of all moderation rules.
      operationId: list-rules
      parameters:
        - $ref: '#/components/parameters/key'
        - $ref: '#/components/parameters/secret'
        - $ref: '#/components/parameters/appId'
        - name: limit
          in: query
          description: The number of records to fetch.
          schema:
            type: string
      responses:
        '200':
          description: List Rule
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      '':
                        $ref: '#/components/schemas/webhookSchema'
                    type: object
                type: object
              example:
                data:
                  - id: moderation-test
                    name: Video Moderation
                    description: AI-powered video moderation to detect unsafe content.
                    enabled: true
                    conditions:
                      - id: 1
                        isKeywordsReferencePresent: false
                        isMediaPresent: true
                        entity: message
                        operand: image
                        category: word
                        operator: contains
                        value:
                          - violence_greaterThan_30
                        message:
                          - >-
                            Image contains violence with confidence greater than
                            30
                    action:
                      - blockMessage
                    active: true
                    createdAt: 1720003247
                    updatedAt: 1720003247
                    revisionId: 253179cf5f665257_moderation-test_1
                  - id: video-moderation1
                    name: Video Moderation
                    description: AI-powered video moderation to detect unsafe content.
                    enabled: true
                    conditions:
                      - id: 1
                        isKeywordsReferencePresent: false
                        isMediaPresent: true
                        entity: message
                        operand: image
                        category: word
                        operator: contains
                        value:
                          - violence_greaterThan_30
                        message:
                          - >-
                            Image contains violence with confidence greater than
                            30
                    action:
                      - blockMessage
                    active: true
                    createdAt: 1720000488
                    updatedAt: 1720000488
                    revisionId: 253179cf5f665257_video-moderation1_1
                  - id: text-profanity-filter
                    name: Text Profanity filter
                    description: Detect and censor profanity in text messages.
                    enabled: true
                    conditions:
                      - id: 1
                        isKeywordsReferencePresent: true
                        isMediaPresent: false
                        entity: message
                        operand: text
                        category: word
                        operator: contains
                        value:
                          - profanity-list
                    action:
                      - blockMessage
                    active: true
                    createdAt: 1718355386
                    updatedAt: 1720006272
                    revisionId: 253157108b5294c4_profanity-filter_25
                    default: true
                  - id: image-moderation
                    name: AI Image Moderation
                    description: AI-powered image moderation to detect unsafe content.
                    enabled: false
                    conditions:
                      - id: 1
                        isKeywordsReferencePresent: false
                        isMediaPresent: true
                        entity: message
                        operand: image
                        category: word
                        operator: contains
                        value:
                          - AnyOf_greaterThan_30
                    action:
                      - blockMessage
                    active: true
                    createdAt: 1718350200
                    updatedAt: 1719932600
                    revisionId: 253157108b5294c4_image-moderation_11
                    default: true
                  - id: video-moderation
                    name: AI Video Moderation
                    description: AI-powered video moderation to detect unsafe content.
                    enabled: false
                    conditions:
                      - id: 1
                        isKeywordsReferencePresent: false
                        isMediaPresent: true
                        entity: message
                        operand: video
                        category: word
                        operator: contains
                        value:
                          - AnyOf_greaterThan_30
                    action:
                      - dropMessage
                    active: true
                    createdAt: 1718350199
                    updatedAt: 1720006008
                    revisionId: 253157108b5294c4_video-moderation_10
                    default: true
                  - id: custom-profanity-filter
                    name: Custom Profanity filter
                    description: Detect and censor profanity in custom messages.
                    enabled: false
                    conditions:
                      - id: 1
                        isListReferencePresent: true
                        isMediaPresent: false
                        entity: message
                        operand: custom
                        category: word
                        operator: contains
                        value:
                          - profanity-list
                    action:
                      - dropMessage
                    active: true
                    createdAt: 1718341200
                    updatedAt: 1719819136
                    revisionId: 253157108b5294c4_profanity-filter_8
                    default: true
                  - id: contact_details_filter
                    name: Contact details filter
                    description: Identifies and removes phone numbers from text
                    enabled: false
                    conditions:
                      - id: 1
                        isKeywordsReferencePresent: false
                        isMediaPresent: false
                        entity: message
                        operand: text
                        category: pattern
                        operator: contains
                        value:
                          - >-
                            \\+?(\\d{1,3})?{-.\\s}?\\(?\\d{1,4}?\\)?{-.\\s}?\\d{1,4}{-.\\s}?\\d{1,4}{-.\\s}?\\d{1,9}
                      - id: 2
                        isKeywordsReferencePresent: false
                        isMediaPresent: false
                        entity: message
                        operand: custom
                        category: pattern
                        operator: contains
                        value:
                          - >-
                            \\+?(\\d{1,3})?{-.\\s}?\\(?\\d{1,4}?\\)?{-.\\s}?\\d{1,4}{-.\\s}?\\d{1,4}{-.\\s}?\\d{1,9}
                    action:
                      - blockMessage
                    active: true
                    createdAt: 1718186338
                    updatedAt: 1719836048
                    revisionId: 2531882e5e289115_contact_details_filter_3
                    default: true
                  - id: email_filter
                    name: Email filter
                    description: Identify and remove email address from messages
                    enabled: false
                    conditions:
                      - id: 1
                        isKeywordsReferencePresent: false
                        isMediaPresent: false
                        entity: message
                        operand: text
                        category: pattern
                        operator: contains
                        value:
                          - ^{a-zA-Z0-9._%+-}+@{a-zA-Z0-9.-}+\\.{a-zA-Z}{2,}$
                      - id: 2
                        isKeywordsReferencePresent: false
                        isMediaPresent: false
                        entity: message
                        operand: custom
                        category: pattern
                        operator: contains
                        value:
                          - ^{a-zA-Z0-9._%+-}+@{a-zA-Z0-9.-}+\\.{a-zA-Z}{2,}$
                    action:
                      - blockMessage
                    active: true
                    createdAt: 1718099938
                    updatedAt: 1719836049
                    revisionId: 2531882e5e289115_contact_email_filter_5
                    default: true
                meta:
                  current:
                    limit: 50
                    count: 8
components:
  parameters:
    key:
      name: key
      in: header
      description: Authorization Key
      required: true
      schema:
        type: string
    secret:
      name: secret
      in: header
      description: Authorization Secret
      required: true
      schema:
        type: string
    appId:
      name: appId
      in: path
      description: AppID in which the extension has to be enabled/disabled
      required: true
      schema:
        type: string
  schemas:
    webhookSchema:
      properties:
        id:
          type: string
        name:
          type: string
        webhookURL:
          type: string
        enabled:
          type: boolean
      type: object

````