Retrieving Rules

The following call will list the Rules in the Project with ID 1998388717:
(Click here to learn how to get your Project ID)

curl -X GET https://api.brandwatch.com/projects/1998388717/rules

The response will look like this. It has been edited for brevity by excluding Filters and Rule Actions that are not affected or required by the Rule.

{
  "resultsTotal": 1,
  "resultsPage": -1,
  "resultsPageSize": -1,
  "results": [
    {
        "id": 2008704947,
        "projectId": 1998388717,
        "name": "Starred FB owner",
        "filter": {
            "queryId": [
                2003165286
            ],
            "facebookRole": "owner",
        },
        "scope": "query",
        "enabled": true,
        "ruleAction": {
            "starred": true,
        },
        "queryName": "Demo Query on NHS",
        "projectName": "Demo 2",
        "categoryId": null,
        "queryIds": null,
        "queries": [
            {
                "id": 2003165286,
                "name": "Demo Query on NHS",
                "sharedWithProjectIds": [
                    1998397716
                ]
            },
         ],
         "creationDate": "2025-11-28T11:22:09.186+0000",
         "lastUpdated": "2025-11-28T11:22:09.186+0000",
         "creator": "[email protected]",
         "modifier": "[email protected]"
     }
  ]
}

This particular example shows a Rule that stars mentions that were posted on a Facebook page by the page owner.

If you know the Rule id then you can get information on that specific Rule using the call below:

curl -X GET https://api.brandwatch.com/projects/1998388717/rules/2008704947