Skip to main content
GET
/
api
/
v1
/
rules
List rules
curl --request GET \
  --url https://breadbox.example.com/api/v1/rules \
  --header 'X-API-Key: <api-key>'
{
  "rules": [
    {
      "id": "<string>",
      "short_id": "<string>",
      "name": "<string>",
      "enabled": true,
      "priority": 123,
      "creator_id": "<string>",
      "condition": {},
      "actions": [
        {}
      ],
      "triggers": [],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "limit": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Query Parameters

cursor
string

Opaque pagination cursor returned by a previous list response.

limit
integer

Page size (default 50, capped per-endpoint).

Required range: 1 <= x <= 200
enabled
boolean
category_id
string
search_mode
enum<string>
Available options:
contains,
words,
fuzzy

Response

200 - application/json

Rules.

rules
object[]
next_cursor
string | null
has_more
boolean
limit
integer