---
title: "List rules"
method: GET
path: "/v0/rules"
tags: ["Rules"]
---

# List rules

`GET /v0/rules`

List rules

## Query parameters

- `in_feed` boolean, nullable — Restrict to rules that are explicitly in or not in a feed
- `limit` integer — The maximum number of entries to return. Maximum value is 500.
- `offset` integer — The (zero-based) offset of the first rule to return
- `search` string, nullable — Search for matching case-insensitive substring across rule name, description, and MQL source

## Response `200`

OK

- HandlerTypesListRulesResponse
  - `count` integer — Count of results for this page
  - `rules` HandlerTypesRule[] — List of rules
    - `active` boolean — Indicates whether or not the rule is active and will flag matching messages
    - `created_at` string, date-time — Rule creation time
    - `description` string, required — Description of rule
    - `id` string, uuid — Rule ID
    - `name` string, required — Rule name
    - `references` string[] — URLs of reference resources for this rule
    - `severity` 'informational' | 'low' | 'medium' | 'high' | 'critical' — Rule severity
    - `source` string, required — Rule MQL (Message Query Language) source
    - `tags` string[] — Freeform tags for this rule (for example, "Executive Impersonation")
    - `updated_at` string, date-time — Rule last updated time
  - `total` integer — Total number of results available

---

[API](https://skmtc.net/sublime/apis/sublime-platform-api.md) · [All operations](https://skmtc.net/sublime/apis/sublime-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sublime/sublime-platform-api/versions/d5df82850357/schema)