---
title: "List current Sinks"
method: GET
path: "/sinks"
tags: ["sink"]
---

# List current Sinks

`GET /sinks`

## Query parameters

- `limit` integer
- `offset` integer
- `name` string
- `order` 'name' | 'id'
- `dir` 'asc' | 'desc'
- `tags` object

## Response `200`

Data retrieved.

- SinkPageSchema
  - `sinks` SinksObjSchema[], required
    - `id` string, uuid, required — Unique identifier (UUID)
    - `name` string — A unique name label
    - `description` string — User description of this Sink
    - `tags` object — User defined key/values for organization and searching
    - `state` 'active' | 'error' — State of this Sink connection to the backend
    - `error` string — Error message from Sink backend connection if the Sink is in error state
    - `backend` string — The sink backend to use. Must match a backend from /features/sinks. Cannot change once created.
    - `config` object — Object representing backend specific configuration information
    - `config_data` string — YAML representing backend specific configuration information
    - `format` 'yaml' | 'json' — Format that the config will be passed on
    - `ts_created` string, date-time — Timestamp of creation
  - `total` integer — Total number of items.
  - `offset` integer — Number of items to skip during retrieval.
  - `limit` integer — Maximum number of items to return in one page.

## Other responses

- `400` — Failed due to malformed query parameters.
- `401` — Missing or invalid access token provided.
- `404` — A non-existent entity request.
- `500` — Unexpected server-side error occurred.

## Changes

- **2026-07-17** `fbedacec6f7d` — 2 info
  - added the optional property `sinks/items/config_data` to the response with the `200` status
  - added the optional property `sinks/items/format` to the response with the `200` status
- **2023-11-30** `fc270bbf9fd1` — 2 warning
  - removed the optional property `sinks/items/config_data` from the response with the `200` status
  - removed the optional property `sinks/items/format` from the response with the `200` status
- **2023-11-30** `659a39c42dc6` — 2 info
  - added the optional property `sinks/items/config_data` to the response with the `200` status
  - added the optional property `sinks/items/format` to the response with the `200` status
- **2022-10-05** `ba366e36c0ce` — 1 breaking
  - added the new required `header` request parameter `Authorization` to all path's operations
- **2022-10-04** `18ac8e9f047d` — 1 breaking
  - added the new required `header` request parameter `Bearer authorization` to all path's operations

[Full history](https://skmtc.dev/orb-community/apis/orb-sinks/changes/sinks/get.md)

---

[API](https://skmtc.dev/orb-community/apis/orb-sinks.md) · [All operations](https://skmtc.dev/orb-community/apis/orb-sinks/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/orb-community/orb-sinks/revisions/fbedacec6f7d/schema)