List Sinks

List of all the stream's sinks.

get/api/v1/stream/{stream_id}/sink

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

Query parameters

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:sink_2yZwUhtgs5Ai8T9yRQJXA

The iterator returned from a prior invocation

order'ascending' | 'descending'

Defines the ordering in a listing of results.

The sorting order of the returned items

Response

doneboolean required

iteratorstring nullable required

prevIteratorstring nullable

Example response

{
  "data": [
    {
      "channels": [
        "project_1337"
      ],
      "eventTypes": [
        "user.signup"
      ],
      "id": "sink_2yZwUhtgs5Ai8T9yRQJXA",
      "uid": "unique-identifier"
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}

Changes

Changed in 3 of the 5 revisions of this API.36

Aug 28, 202650dde67d2d2d11See the full diff
- ▲
  added StreamSinkOut_postgres to the data/items/ response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  added postgres discriminator mapping keys to the data/items/ response property for the response status 200
  response-property-discriminator-mapping-added
Aug 19, 2026dc130bd1b07413See the full diff
- ▲
  added StreamSinkOut_poller StreamSinkOut_azureBlobStorage StreamSinkOut_otelTracing StreamSinkOut_http StreamSinkOut_amazonS3 StreamSinkOut_snowflake StreamSinkOut_googleCloudStorage StreamSinkOut_googleCloudPubSub StreamSinkOut_redshift StreamSinkOut_bigQuery StreamSinkOut_clickhouse StreamSinkOut_rabbitMq StreamSinkOut_sqs StreamSinkOut_eventBridge StreamSinkOut_sns to the data/items/ response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  added the optional property data/items/channels to the response with the 200 status
  response-optional-property-added
- ○
  added discriminator to data/items/ response property for the response status 200
  response-property-discriminator-added
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 from the data/items/ response property oneOf list for the response status 200
  response-property-one-of-removed
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 202616dbcc056c4812See the full diff
- ▲
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 to the data/items/ response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  removed discriminator from data/items/ response property for the response status 200
  response-property-discriminator-removed
- ○
  removed StreamSinkOut_poller StreamSinkOut_azureBlobStorage StreamSinkOut_otelTracing StreamSinkOut_http StreamSinkOut_amazonS3 StreamSinkOut_googleCloudStorage StreamSinkOut_googleCloudPubSub StreamSinkOut_sqs StreamSinkOut_sns StreamSinkOut_bigQuery StreamSinkOut_clickhouse StreamSinkOut_eventBridge StreamSinkOut_snowflake StreamSinkOut_rabbitMq StreamSinkOut_redshift from the data/items/ response property oneOf list for the response status 200
  response-property-one-of-removed
This revision also has 157 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history