Rules

List rules

List rules for your organization. With sort_by=order (the default), results follow rule-set order and then local rule order. Use rule_set_id to return rules from one containing set.

get/v1/rules

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/rules
Auth: HTTP bearer

Query parameters

limitinteger

Return at most this many records, from 1 to 200, default 50.

cursorstring

The next_cursor from the previous response, valid only with the same endpoint and filters.

program_idstring uuid

Filter by program ID

rule_set_idstring uuid

Filter by containing rule set ID

include_archivedboolean

Include archived rules

status'ACTIVE' | 'SUSPENDED' | 'ARCHIVED'

Filter by rule status

searchstring

Search by rule name (partial match)

sort_by'order' | 'created_at' | 'name'

Sort field

sort_dir'asc' | 'desc'

Sort direction

created_afterstring date-time

Return only records created after this time, RFC 3339.

created_beforestring date-time

Return only records created before this time, RFC 3339.

Response

List of rules

Example response

{
  "data": [
    {
      "actions": [
        {
          "amount": "${{ event.amount * 10 }}",
          "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
          "type": "CREDIT"
        }
      ],
      "active_from": "2027-01-01T00:00:00Z",
      "active_to": "2027-12-31T23:59:59Z",
      "budgets": [
        {
          "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
          "consumed": "4500.00",
          "cron_expression": "0 0 1 * *",
          "interval": "720h",
          "limit": "10000.00",
          "next_reset_at": "2027-12-31T23:59:59Z",
          "schedule_type": "CRON",
          "scope": "PROGRAM"
        }
      ],
      "condition": "event.type == 'purchase' && event.amount > 0",
      "created_at": "2027-01-15T10:30:00Z",
      "deleted_at": "2027-01-15T10:30:00Z",
      "description": "Awards 10 points per dollar spent",
      "id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b03",
      "name": "Purchase Reward",
      "order": 1,
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "rule_configuration_version": 4,
      "rule_set_id": "d4735e3a-265e-4f16-b1a5-4c8e9d6f0a04",
      "status": "ACTIVE",
      "updated_at": "2027-01-15T10:30:00Z",
      "warnings": [
        {
          "code": "unknown_state_key",
          "key": "purchaseCnt",
          "kind": "counter",
          "message": "unknown counter \"purchaseCnt\" on participant: no rule in this program writes it; did you mean \"purchase_count\"?",
          "scope": "participant",
          "suggestion": "purchase_count"
        }
      ]
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.