# List keyword rules

> Your keyword rules, in the order they are tried.

`GET /v1/automations/rules`

Your keyword rules, in the order they are tried. The first rule that matches a text wins.

Needs a key with the `messages:read` scope. [Keys and scopes](https://usebluebot.com/docs/concepts/api-keys)

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | How many to return, 1 to 100. Default 25. 1 to 100. Default `25` |
| `cursor` | string | No | The `next_cursor` of the page before. Leave it out for the first page. Up to 200 characters |

## Example

```bash
curl "https://usebluebot.com/api/v1/automations/rules" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"
```

```ts
import BlueBot from '@usebluebot/sdk';

const client = new BlueBot({ apiKey: process.env.BLUEBOT_API_KEY });

const page = await client.automations.rules.list();
console.log(page.data);
```

```python
import os
from bluebot import BlueBot

client = BlueBot(api_key=os.environ["BLUEBOT_API_KEY"])

page = client.automations.rules.list()
print(page.data)
```

## Response

`200`: A page of rules.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | "list" | Yes |   |
| `data` | array of KeywordRule | Yes |   |
| `data[].id` | string | Yes | A kw_ id. Starts with `kw_` |
| `data[].object` | "keyword_rule" | Yes |   |
| `data[].name` | string | Yes |   |
| `data[].match` | string | Yes | `exact` (the whole text), `starts_with`, `word` (a whole word anywhere), `contains`, or `regex`. One of `exact`, `starts_with`, `word`, `contains`, `regex` |
| `data[].keywords` | array of strings | Yes |   |
| `data[].pattern` | string or null | Yes | For `regex`. |
| `data[].case_sensitive` | boolean | Yes |   |
| `data[].actions` | array of any | Yes |   |
| `data[].position` | integer | Yes | Rules are tried from the lowest position up; the first match wins. |
| `data[].enabled` | boolean | Yes |   |
| `data[].fire_count` | integer | Yes | How many texts it answered. |
| `data[].last_fired_at` | timestamp or null | Yes | When it last matched. |
| `data[].created_at` | timestamp | Yes | When it was made. |
| `has_more` | boolean | Yes | Whether another page follows. |
| `next_cursor` | string or null | Yes | Send as `cursor` for the next page; null on the last. |

The answer, `200`:

```json
{
  "object": "list",
  "data": [
    {
      "id": "kw_1Hq2LxW9cVbN3mKpRtYs0a",
      "object": "keyword_rule",
      "name": "Pricing",
      "match": "word",
      "keywords": [
        "price",
        "pricing",
        "cost"
      ],
      "pattern": null,
      "case_sensitive": false,
      "actions": [
        {
          "type": "reply",
          "text": "Our plans start at $29 a month. Want me to send the details?",
          "template_id": null
        },
        {
          "type": "tag",
          "tags": [
            "asked-pricing"
          ]
        }
      ],
      "position": 10,
      "enabled": true,
      "fire_count": 18,
      "last_fired_at": "2026-11-13T17:20:00.000Z",
      "created_at": "2026-11-02T15:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

## Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

| Code                                                    | Status | What it means                                                                                                                                    |
| ------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`unauthorized`](https://usebluebot.com/docs/errors/unauthorized)             | 401    | The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API.                                |
| [`insufficient_scope`](https://usebluebot.com/docs/errors/insufficient_scope) | 403    | The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope.                                                   |
| [`rate_limited`](https://usebluebot.com/docs/errors/rate_limited)             | 429    | Too many requests. A key may make 120 requests a minute. The `RateLimit` header says how many are left, and `Retry-After` how long to wait.      |
| [`internal`](https://usebluebot.com/docs/errors/internal)                     | 500    | Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe.                    |
| [`invalid_request`](https://usebluebot.com/docs/errors/invalid_request)       | 400    | Something in the request doesn’t fit: a missing or malformed field, a bad id, or a combination the endpoint refuses. `details` names each field. |

## Try it