> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs-parschat.parstechai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-parschat.parstechai.com/_mcp/server.

# List rules

GET https://api-chat.parstechai.com/v1/robots/{robot_id}/channels/{channel_id}/rules

Returns the rules on a channel. Filter by `is_active` or by trigger kind.

Reference: https://docs-parschat.parstechai.com/api-reference/instagram-automation/list-rules

## Authentication

- `Authorization` header (bearer token, required) — Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as `Authorization: Bearer pk_live_…`.

## Request

### Path parameters

- `robot_id` (string, required) — The robot's id, as returned by the create call.
- `channel_id` (string, required) — The channel's id.

### Query parameters

- `is_active` (boolean, optional) — Return only active, or only inactive, rules.
- `on` (enum, optional) — Return only DM rules or only comment rules.
  - Allowed values: `dm`, `comment`
- `limit` (integer, optional, default: 50) — How many items to return per page.
- `offset` (integer, optional, default: 0) — How many records to skip. Use `offset = page * limit`, and `total_count` from the response to know when to stop.

## Response

### 200

A page of rules.

- `data` (list of Rule, optional)
- `pagination` (Pagination, optional) — Offset pagination. `total_count` tells you how many records match, so you know how many pages to fetch before you start.

## Errors

### 400 Bad Request Error

The request itself is malformed: a parameter is missing, unparseable, or out of range. Unlike 422, the request never reached validation of its contents.

- `error` (ErrorError, optional)

### 401 Unauthorized Error

The key is missing, wrong, revoked, or past its expiry date. All four answer `invalid_key`: telling an expired key from an unknown one would confirm to whoever holds a leaked key that it was once real.

- `error` (ErrorError, optional)

### 403 Forbidden Error

The call is understood but not permitted: a missing role, a lapsed plan, or exhausted capacity.

- `error` (ErrorError, optional)

### 404 Not Found Error

No such resource, or it belongs to another partner. We return 404 rather than 403 here, because a 403 would confirm the id exists.

- `error` (ErrorError, optional)

### 429 Too Many Requests Error

You are calling the API too fast. `details` names the limit you are held to. This never means an automated reply to an end customer was discarded: those are queued, not dropped.

- `error` (ErrorError, optional)

### 500 Internal Server Error

Something failed on our side. Retry with backoff, and quote `request_id` if it persists.

- `error` (ErrorError, optional)

### 503 Service Unavailable Error

A service we depend on (a channel provider, or our AI service) is unavailable. Retry with backoff.

- `error` (ErrorError, optional)

## Types

### Rule

A keyword-triggered automation on one channel.

- `id` (string, optional) — ParsChat identifier for the rule.
- `name` (string, optional) — Your label for the rule. Shown in the panel.
- `trigger` (Trigger, optional) — What makes a rule fire.
- `actions` (list of Action, optional) — What to send on a DM rule.
- `reply_in_comment` (RuleReplyInComment, optional) — Comment rules only. Posts a public reply under the comment.
- `then_send_dm` (list of Action, optional) — Comment rules only. Follows the public reply with a private message.
- `require_follow` (RequireFollow, optional) — Withhold the reply until the commenter follows the page. The verification round-trip is ours: you do not implement it.
- `is_active` (boolean, optional, default: true) — Whether the rule is currently firing.
- `created_at` (datetime, optional) — When the rule was created.

### Pagination

Offset pagination. `total_count` tells you how many records match, so you know how many pages to fetch before you start.

- `limit` (integer, optional) — How many items were requested per page.
- `offset` (integer, optional) — How many items were skipped to reach this page.
- `total_count` (integer, optional) — Total records matching the query, across every page. Divide by `limit` to get the number of calls you need.
- `has_more` (boolean, optional) — Whether another page exists after this one.

### ErrorError

- `code` (string, optional) — Stable machine-readable code. Branch on this, not on the message.
- `message` (string, optional) — Human-readable explanation. Wording may change.
- `request_id` (string, optional) — Log this. It is what lets support find your exact request.
- `details` (map from string to any, optional) — Machine-readable context for the code. On `capacity_exhausted` it carries `occupied`, `requested` and `capacity`; on `rate_limited`, `limit_per_minute` and `window_seconds`.

### Trigger

What makes a rule fire.

- `on` (enum, required) — `dm` matches direct messages. `comment` matches comments on posts and reels.
  - Allowed values: `dm`, `comment`
- `keywords` (list of string, required) — Words that trigger the rule. At least one is required.
- `match` (enum, optional, default: contains) — `contains` matches a keyword anywhere in the text. `equal` requires the whole message to match.
  - Allowed values: `contains`, `equal`
- `media_id` (string, optional) — Comment rules only. Scopes the rule to one post or reel. Omit it and the rule applies to every post. Get ids from the media endpoint.

### Action

One step of a reply. The vocabulary is closed: an unknown `type` returns 422, so new action types can be added without breaking a partner who guessed.

- `type` (enum, required) — Which kind of step this is.
  - Allowed values: `text`, `image`, `link`, `delay`
- `body` (string, optional) — Message text. Required when `type` is `text`.
- `url` (string, optional) — Destination for a `link`, or the image source for an `image`.
- `label` (string, optional) — Button label for a `link`.
- `seconds` (integer, optional) — How long to wait. Used when `type` is `delay`.

### RuleReplyInComment

Comment rules only. Posts a public reply under the comment.

- `body` (string, optional) — The public reply text.

### RequireFollow

Withhold the reply until the commenter follows the page. The verification round-trip is ours: you do not implement it.

- `enabled` (boolean, optional) — Whether the gate applies to this rule.
- `prompt` (string, optional) — Sent instead of the reply when the sender does not follow.
- `button_text` (string, optional) — Label on the postback button, tapped inside Instagram.
- `retry_prompt` (string, optional) — Sent when someone taps the button before actually following.

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "rul_7nQ2xK",
      "name": "Price enquiry to catalogue",
      "trigger": {
        "on": "dm",
        "keywords": [
          "price",
          "how much",
          "cost"
        ],
        "match": "contains"
      },
      "actions": [
        {
          "type": "text",
          "body": "Hello! Here is our catalogue."
        },
        {
          "type": "link",
          "url": "https://shop.example/catalogue",
          "label": "Catalogue"
        }
      ],
      "is_active": true,
      "created_at": "2026-09-20T11:12:00Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total_count": 1,
    "has_more": false
  }
}
```

**SDK Code**

```python One active rule
import requests

url = "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript One active rule
const url = 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go One active rule
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby One active rule
require 'uri'
require 'net/http'

url = URI("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java One active rule
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php One active rule
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp One active rule
using RestSharp;

var client = new RestClient("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift One active rule
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```