---
title: "List custom sink declarations"
method: POST
path: "/api/v2/customSinks/list"
tags: ["Custom Sinks"]
---

# List custom sink declarations

`POST /api/v2/customSinks/list`

## Request

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

List all custom sink declarations for the organization, optionally filtered by repository. Supports cursor-based pagination.

## Request body

- ListCustomSinksInput
  - `organizationId` string
  - `repositoryId` string: Filter sinks by repository
  - `cursor` string: Opaque cursor for pagination (from nextCursor in previous response)
  - `limit` integer: Number of sinks to return per page

## Response `200`

Successful response

- CustomSinkListResponse
  - `items` CustomSink[], required
    - `id` string, required
    - `name` string, required
    - `description` string, required
    - `globPattern` string, required
    - `enabled` boolean, required
    - `repositoryIds` string[], required
    - `scope` 'allRepositories' | 'repositories' | 'tags', required: Where the declaration applies: every repository, the listed repositories, or repositories carrying its tags.
    - `tags` RuleTag[], required
      - `id` string, required
      - `name` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `totalCount` integer, required
  - `hasMore` boolean, required
  - `nextCursor` string, nullable, required

## Other responses

- `400`: Error Response
- `401`: Error Response

---

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