---
title: "List custom rules"
method: POST
path: "/api/v2/rules/list"
tags: ["Rules"]
---

# List custom rules

`POST /api/v2/rules/list`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v2/rules/list`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

List all custom rules for the organization, optionally filtered by repository

## Request body

- ListRulesInput
  - `organizationId` string
  - `repositoryId` string: Filter rules by repository
  - `page` integer
  - `pageSize` integer

## Response `200`

Successful response

- RuleListResponse
  - `rules` Rule[], required
    - `id` string, required
    - `name` string, required
    - `rule` string, required: Natural language description of the security rule
    - `globPattern` string, required
    - `sourceTypes` string[], required
    - `repositoryIds` string[], required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `totalCount` integer, required
  - `page` integer, required
  - `pageSize` integer, required
  - `totalPages` integer, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

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