---
title: "List custom rules"
method: GET
path: "/custom-rules"
tags: ["CustomRules"]
---

# List custom rules

`GET /custom-rules`

## Request

- Base URL: `https://public.escape.tech/v3`
- URL: `https://public.escape.tech/v3/custom-rules`
- Auth: API key in header `X-ESCAPE-API-KEY`

List and search custom rules of the organization.

## Query parameters

- `cursor` string: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
- `size` integer: The number of items to return per page
- `context` string: Filter by custom rule context
- `search` string: Search term to filter custom rules by name

## Response `200`

OK

- object[]
  - `id` string, uuid, required: The id of the rule
  - `name` string, required: The name of the rule
  - `context` string, required: The context of the rule
  - `severity` string, required: The severity of the rule
  - `createdAt` string, required: The creation date of the rule
  - `updatedAt` string, required: The last update date of the rule

## Other responses

- `400`: Pagination error

---

[API](https://skmtc.dev/escape/apis/escape-public-api.md) - [All operations](https://skmtc.dev/escape/apis/escape-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/escape/apis/escape-public-api/revisions/2eab35df40c7?raw)
