---
title: "Get custom sink declaration"
method: POST
path: "/api/v2/customSinks/get"
tags: ["Custom Sinks"]
---

# Get custom sink declaration

`POST /api/v2/customSinks/get`

## Request

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

Get details of a specific custom sink declaration including associated repositories.

## Request body

- GetCustomSinkInput
  - `organizationId` string
  - `declarationId` string, required

## Response `200`

Successful response

- CustomSinkWithRepositories
  - `id` string, required
  - `name` string, required
  - `description` string, required
  - `globPattern` string, required
  - `enabled` boolean, required
  - `repositories` object[], required
    - `id` string, required
    - `name` 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

## Other responses

- `400`: Error Response
- `401`: Error Response
- `404`: 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)