GET

Get Rule

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a rule by ID.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Moderation Rules
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/moderation/v1/rules/{ruleId}
Path Params
ruleIdstringRequired

Rule ID.

Response Object
ruleRule

Requested rule.

Get a rule
Request
cURL
curl -X GET https://www.wixapis.com/moderation/v1/rules/500ea62c-5f4c-4a51-b813-0bd7f239c6dd  \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: <AUTH>'
Response
JSON
{
  "rule": {
    "id": "500ea62c-5f4c-4a51-b813-0bd7f239c6dd",
    "revision": "1",
    "createdDate": "2023-10-10T06:52:04.718Z",
    "updatedDate": "2023-10-10T06:52:04.718Z",
    "namespace": "reviews/f0f2e34e-a407-41bd-b8b0-d11a90b226de",
    "name": "Check for Rating",
    "audience": {
      "type": "MEMBERS_AND_VISITORS"
    },
    "trigger": {
      "attribute": {
        "name": "rating",
        "values": ["1", "2"]
      }
    },
    "exemptions": {
      "memberGroups": [],
      "memberIds": []
    },
    "action": {
      "type": "NEEDS_MANUAL_APPROVAL"
    },
    "enabled": true
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?