# Get a keyword rule

> One keyword rule, with what it matches and does.

`GET /v1/automations/rules/{id}`

One keyword rule, with what it matches and does.

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

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The rule’s id. Starts with `kw_` |

## Example

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

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

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

const rule = await client.automations.rules.get('kw_1Hq2LxW9cVbN3mKpRtYs0a');
console.log(rule);
```

```python
import os
from bluebot import BlueBot

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

rule = client.automations.rules.get("kw_1Hq2LxW9cVbN3mKpRtYs0a")
print(rule)
```

## Response

`200`: The rule.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | A kw_ id. Starts with `kw_` |
| `object` | "keyword_rule" | Yes |   |
| `name` | string | Yes |   |
| `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` |
| `keywords` | array of strings | Yes |   |
| `pattern` | string or null | Yes | For `regex`. |
| `case_sensitive` | boolean | Yes |   |
| `actions` | array of any | Yes |   |
| `position` | integer | Yes | Rules are tried from the lowest position up; the first match wins. |
| `enabled` | boolean | Yes |   |
| `fire_count` | integer | Yes | How many texts it answered. |
| `last_fired_at` | timestamp or null | Yes | When it last matched. |
| `created_at` | timestamp | Yes | When it was made. |

The answer, `200`:

```json
{
  "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"
}
```

## 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.               |
| [`not_found`](https://usebluebot.com/docs/errors/not_found)                   | 404    | There is no such thing on this account. Ids are prefixed by kind, so a message id starts with `msg_`.                                       |

## Try it