---
title: "List rule sets"
method: GET
path: "/api/v1/rule_sets"
tags: ["Rule Sets"]
---

# List rule sets

`GET /api/v1/rule_sets`

## Request

- Base URL: `https://getscaleforge.com`
- URL: `https://getscaleforge.com/api/v1/rule_sets`
- Auth: HTTP bearer

Paginated. Requires scope `rules:read`.

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

Success

- object
  - `data` object[]
    - `id` integer
    - `name` string
    - `action` 'pause' | 'activate' | 'bid_up' | 'bid_down'
    - `bid_step` number, nullable
    - `bid_min` number, nullable
    - `bid_max` number, nullable
    - `schedule_type` 'interval' | 'hourly' | 'daily'
    - `schedule_value` integer, nullable: Minutes for interval type
    - `data_period` string
    - `enabled` boolean
    - `cooldown_minutes` integer
    - `dry_run` boolean
    - `max_daily_actions` integer, nullable
    - `target_level` 'adset' | 'campaign'
    - `next_run_at` string, date-time, nullable
    - `created_at` string, date-time
  - `meta` Pagination
    - `page` integer
    - `per_page` integer
    - `total_count` integer
    - `total_pages` integer

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/getscaleforge/apis/scaleforge-api.md) · [All operations](https://skmtc.dev/getscaleforge/apis/scaleforge-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getscaleforge/apis/scaleforge-api/revisions/ca382e62f404?raw)