Skip to main content
GET
/
rules
List rules
curl --request GET \
  --url https://api.breezing.io/v1/rules
{
  "success": true,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "actions": [
        null
      ],
      "conditionsLength": 123,
      "actionsLength": 123,
      "isActive": true,
      "orgId": 123,
      "companyId": 123,
      "createdAt": 123,
      "updatedAt": 123,
      "conditions": "<unknown>"
    }
  ],
  "pagination": {
    "limit": 123,
    "cursor": 123,
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://learn.breezing.io/llms.txt

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

Query Parameters

org_id
string
required

Organization ID. Use GET /v1/companies to discover available org/company pairs.

Example:

"1"

company_id
string
required

Company ID. Use GET /v1/companies to discover available companies and their access levels.

Example:

"1"

cursor
string

Rule ID to start after (cursor pagination, ordered id desc).

limit
string
default:50

Number of rules to return (1-100, default 50)

Filter by rule name (prefix match, case-insensitive).

Response

Rules retrieved successfully

success
enum<boolean>
required
Available options:
true
data
object[]
required
pagination
object
required
Last modified on May 3, 2026