GET
/
sinks
curl -X GET "https://api.sequinstream.com/api/sinks" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "data": [
    {
      "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
      "name": "my-kafka-sink",
      "status": "active",
      "table": "public.records",
      "filters": [],
      "destination": {
        "type": "kafka",
        "hosts": "localhost:9092",
        "tls": false,
        "topic": "records",
        "username": "kafka_user",
        "password": "kafka_password",
        "sasl_mechanism": "PLAIN"
      },
      "database": "dune",
      "transform": "id-transform",
      "active_backfill": null,
      "batch_size": 50,
      "actions": ["insert", "update", "delete"],
      "group_column_names": ["id"],
      "timestamp_format": "iso8601"
    }
  ]
}

Returns a list of all sink consumers.

​
Response fields

​
data
data[]

Where data is an array of objects with the following fields:

​
id
string

The unique identifier of the sink consumer

​
name
string

The name of the sink consumer

​
status
string

The current status of the sink consumer (active, disabled, paused)

​
table
string

The source table for the sink consumer.

The table name is of the format schema.table. Schema is optional and defaults to public.

​
filters
array

Array of filters to apply to the source data

​
destination
object

The destination configuration for the sink consumer. The shape varies by destination type.

​
database
string

The source database for the sink consumer.

When you create a database in Sequin, you specify the name of the database resource. That value is this database field.

​
transform
string

The transform to apply to messages.

This is the name of the transform that you created in the Sequin console.

​
active_backfill
string

The ID of the active backfill, if any.

Backfills that were completed or cancelled will not appear here.

​
batch_size
integer

Number of records to batch together (1-1000)

This is the number of records that will be sent in a single message to the destination.

​
actions
array

The database actions to include in the sink.

Possible values include insert, update, delete.

​
group_column_names
array

Column names used for grouping records

​
timestamp_format
string

The format of the timestamp in the source data.

Possible values include iso8601 and unix_microsecond.

curl -X GET "https://api.sequinstream.com/api/sinks" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "data": [
    {
      "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
      "name": "my-kafka-sink",
      "status": "active",
      "table": "public.records",
      "filters": [],
      "destination": {
        "type": "kafka",
        "hosts": "localhost:9092",
        "tls": false,
        "topic": "records",
        "username": "kafka_user",
        "password": "kafka_password",
        "sasl_mechanism": "PLAIN"
      },
      "database": "dune",
      "transform": "id-transform",
      "active_backfill": null,
      "batch_size": 50,
      "actions": ["insert", "update", "delete"],
      "group_column_names": ["id"],
      "timestamp_format": "iso8601"
    }
  ]
}