List keyword 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

Query parameters

• limitinteger

  How many to return, 1 to 100. Default 25.

  1 to 100.Default 25.

• cursorstring

  The next_cursor of the page before. Leave it out for the first page.

  Up to 200 characters.

Example

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

Response

200: A page of rules.

• object"list"required
• dataarray of KeywordRulerequired
  Show its 13 fieldsHide its fields

  • idstringrequired

    A kw_ id.

    Starts with kw_.

  • object"keyword_rule"required
  • namestringrequired
  • matchstringrequired

    exact (the whole text), starts_with, word (a whole word anywhere), contains, or regex.

    One of exact, starts_with, word, contains, regex.

  • keywordsarray of stringsrequired
  • patternstring or nullrequired

    For regex.

  • case_sensitivebooleanrequired
  • actionsarray of anyrequired
  • positionintegerrequired

    Rules are tried from the lowest position up; the first match wins.

  • enabledbooleanrequired
  • fire_countintegerrequired

    How many texts it answered.

  • last_fired_attimestamp or nullrequired

    When it last matched.

  • created_attimestamprequired

    When it was made.

• has_morebooleanrequired

  Whether another page follows.

• next_cursorstring or nullrequired

  Send as cursor for the next page; null on the last.

{
  "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.

Try it