---
title: "List Sinks"
method: GET
path: "/api/v1/stream/{stream_id}/sink"
tags: ["Sink"]
---

# List Sinks

`GET /api/v1/stream/{stream_id}/sink`

List of all the stream's sinks.

## Path parameters

- `stream_id` string, required — The Stream's ID or UID.

## Query parameters

- `limit` integer — Limit the number of returned items
- `iterator` string, nullable — The iterator returned from a prior invocation
- `order` 'ascending' | 'descending' — Defines the ordering in a listing of results.

## Response `200`

- ListResponseStreamSinkOut
  - `data` StreamSinkOut[], required
    - union
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `type` 'poller', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` AzureBlobStorageConfigOut, required
          - `account` string, required
          - `container` string, required
        - `type` 'azureBlobStorage', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` OtelTracingConfigOut, required
          - `headers` EndpointHeadersOut, required — The value of the headers is returned in the `headers` field. Sensitive headers that have been redacted are returned in the sensitive field.
            - `headers` object, required
            - `sensitive` string[], required
          - `url` string, uri, required
        - `type` 'otelTracing', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` SinkHttpConfigOut, required
          - `headers` EndpointHeadersOut, required — The value of the headers is returned in the `headers` field. Sensitive headers that have been redacted are returned in the sensitive field.
            - `headers` object, required
            - `sensitive` string[], required
          - `url` string, uri, required
        - `type` 'http', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` S3ConfigOut, required
          - `accessKeyId` string, required
          - `bucket` string, required
          - `endpointUrl` string, uri, nullable
          - `region` string, required
        - `type` 'amazonS3', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` SnowflakeConfigOut, required
          - `accountIdentifier` string, required
          - `dbName` string — Database name. Only required if not using transformations.
          - `schemaName` string — Schema name. Only required if not using transformations.
          - `tableName` string — Table name. Only required if not using transformations.
          - `userId` string, required
        - `type` 'snowflake', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` GoogleCloudStorageConfigOut, required
          - `bucket` string, required
        - `type` 'googleCloudStorage', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` GoogleCloudPubSubConfigOut, required
          - `projectId` string, required
          - `topicId` string, required
        - `type` 'googleCloudPubSub', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` RedshiftConfigOut, required
          - `accessKeyId` string, required
          - `clusterIdentifier` string, nullable
          - `dbName` string — Database name. Only required if not using transformations.
          - `dbUser` string, nullable
          - `region` string, required
          - `schemaName` string, nullable — Schema name. Only used if not using transformations.
          - `tableName` string — Table name. Only required if not using transformations.
          - `workgroupName` string, nullable
        - `type` 'redshift', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` BigQueryConfigOut, required
          - `datasetId` string, required
          - `projectId` string, required
          - `tableId` string, required
        - `type` 'bigQuery', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` ClickhouseConfigOut, required
          - `database` string, required
          - `tableName` string, required
          - `url` string, uri, required
          - `username` string, required
        - `type` 'clickhouse', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` RabbitMqConfigOut, required
          - `routingKey` string, required
        - `type` 'rabbitMq', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` SqsConfigOut, required
          - `accessKeyId` string, required
          - `endpointUrl` string, uri, nullable
          - `queueUrl` string, uri, required
          - `region` string, required
        - `type` 'sqs', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` EventBridgeConfigOut, required
          - `accessKeyId` string, required
          - `detailType` string, required
          - `eventBusName` string, required
          - `region` string, required
        - `type` 'eventBridge', required
      - object
        - `batchSize` integer, required
        - `channels` string[]
        - `createdAt` string, date-time, required
        - `currentIterator` string, required
        - `eventTypes` string[]
        - `failureReason` string, nullable
        - `id` string, required — The sink's ID.
        - `maxWaitSecs` integer, required
        - `metadata` object, required
        - `nextRetryAt` string, date-time, nullable
        - `status` 'enabled' | 'paused' | 'disabled' | 'retrying', required
        - `uid` string, nullable — The sink's UID.
        - `updatedAt` string, date-time, required
        - `config` SnsConfigOut, required
          - `accessKeyId` string, required
          - `region` string, required
          - `topicArn` string, required
        - `type` 'sns', required
  - `done` boolean, required
  - `iterator` string, nullable, required
  - `prevIterator` string, nullable

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Validation Error
- `429` — Too Many Requests

---

[API](https://skmtc.net/svix/apis/svix-api.md) · [All operations](https://skmtc.net/svix/apis/svix-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/svix/svix-api/revisions/b0c8a1820333/schema)