> ## Documentation Index > Fetch the complete documentation index at: https://sequinstream.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List sink consumers Returns a list of all sink consumers. ## Response fields Where data is an array of objects with the following fields: The unique identifier of the sink consumer The name of the sink consumer The current status of the sink consumer (active, disabled, paused) The source database for the sink consumer The source configuration for the sink consumer. This determines which tables are consumed. List of schemas to include, or null to include all List of schemas to exclude, or null to exclude none List of tables to include, or null to include all A table name can be specified with schema (e.g. `my-schema.my-table`) or without (e.g. `my-table`) which defaults to schema `public`. List of tables to exclude, or null to exclude none A table name can be specified with schema (e.g. `my-schema.my-table`) or without (e.g. `my-table`) which defaults to schema `public`. Additional configuration for individual tables. To configure which tables are consumed, see the `source` field. The name of the table. A table name can be specified with schema (e.g. `my-schema.my-table`) or without (e.g. `my-table`) which defaults to schema `public`. The column names to group by or `null` to disable grouping The database actions to include in the sink (insert, update, delete) The destination configuration for the sink consumer. The shape varies by destination type. Must be "azure\_event\_hub" Event Hub namespace Event Hub name Shared access key name Shared access key Must be "elasticsearch" Elasticsearch endpoint URL Elasticsearch index name Authentication type (api\_key, basic, bearer) Authentication value Number of documents to batch together (default: 100) Must be "gcp\_pubsub" GCP project ID PubSub topic ID Base64-encoded credentials Whether to use the emulator Emulator base URL if using emulator Must be "webhook" HTTP endpoint name HTTP endpoint path Whether the webhook body [should be wrapped in a list](/reference/sinks/webhooks#request-format) to support batching. Must be "kafka" Comma-separated list of Kafka hosts Whether to use TLS Kafka topic name Optional username for authentication Optional password for authentication Optional SASL mechanism (plain, scram\_sha\_256, scram\_sha\_512, aws\_msk\_iam) AWS region (required for aws\_msk\_iam) AWS access key ID (required for aws\_msk\_iam) AWS secret access key (required for aws\_msk\_iam) Must be "kinesis" Kinesis stream ARN AWS access key ID AWS secret access key Must be "meilisearch" Meilisearch endpoint URL Meilisearch index name Primary key field name (default: "id") Meilisearch API key Number of documents to batch together (default: 100) Request timeout in seconds (default: 5) Must be "nats" NATS host NATS port Optional username for authentication Optional password for authentication Optional JWT for authentication Optional NKey seed for authentication Whether to use TLS Must be "rabbitmq" RabbitMQ host RabbitMQ port Username for authentication Password for authentication Virtual host name (default: "/") Whether to use TLS Exchange name Must be "redis\_stream" Redis host Redis port Redis stream key Redis database number (default: 0) Whether to use TLS Optional username for authentication Optional password for authentication Must be "redis\_string" Redis host Redis port Redis database number (default: 0) Whether to use TLS Optional username for authentication Optional password for authentication Optional TTL in milliseconds for the keys Mode of operation (static or dynamic, default: static) Must be "s2" The name of the S2 basin The name of the S2 stream The access token for the S2 account associated with the basin and stream Must be "sequin\_stream" Must be "sns" SNS topic ARN AWS region AWS access key ID AWS secret access key Whether the topic is a FIFO topic Must be "sqs" SQS queue URL AWS region AWS access key ID AWS secret access key Whether the queue is a FIFO queue Must be "typesense" Typesense endpoint URL Typesense collection name Typesense API key Number of documents to batch together (default: 100) Request timeout in seconds (default: 5) The [filter function](/reference/filters) for the sink consumer The [transform function](/reference/transforms) for the sink consumer The [routing function](/reference/routing) for the sink consumer The [enrichment function](/reference/enrichment) for the sink consumer Whether message grouping is enabled for delivery ordering See [message grouping and ordering](/reference/sinks/overview#message-grouping-and-ordering) for more details. The maximum number of times a message will be retried if delivery fails User-defined annotations for the sink consumer Array of active backfill IDs Number of records to batch together (1-1000) Determines how Sequin handles overload when sink consumers can't keep up with incoming messages The format of the timestamp in the source data Health status information for the sink consumer Name of the health check Overall health status Array of individual health checks ```bash cURL theme={null} curl -X GET "https://api.sequinstream.com/api/sinks" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` ```json Kafka theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-kafka-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "kafka", "hosts": "localhost:9092", "tls": false, "topic": "records", "username": "kafka_user", "password": "kafka_password", "sasl_mechanism": "PLAIN" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json SQS theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-sqs-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "sqs", "queue_url": "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue", "region": "us-east-1", "access_key_id": "AKIAIOSFODNN7EXAMPLE", "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json RabbitMQ theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-rabbitmq-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "rabbitmq", "host": "localhost", "port": 5672, "username": "guest", "password": "guest", "virtual_host": "/", "tls": false, "exchange": "records" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Redis theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-redis-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "redis_stream", "host": "localhost", "port": 6379, "stream_key": "records", "database": 0, "tls": false, "username": "redis_user", "password": "redis_password" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Azure Event Hub theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-azure-event-hub-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "azure_event_hub", "namespace": "my-namespace", "event_hub_name": "records", "shared_access_key_name": "RootManageSharedAccessKey", "shared_access_key": "your-shared-access-key" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json NATS theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-nats-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "nats", "host": "localhost", "port": 4222, "username": "nats_user", "password": "nats_password", "jwt": "your-jwt-token", "nkey_seed": "your-nkey-seed", "tls": false }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json GCP PubSub theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-gcp-pubsub-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "gcp_pubsub", "project_id": "my-project", "topic_id": "records", "credentials": "base64-encoded-credentials", "use_emulator": false, "emulator_base_url": "http://localhost:8085" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Sequin Stream theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-sequin-stream-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "sequin_stream" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Webhook theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-webhook-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "webhook", "http_endpoint": "my-endpoint", "http_endpoint_path": "/webhook", "batch": true }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Elasticsearch theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-elasticsearch-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "elasticsearch", "endpoint_url": "http://localhost:9200", "index_name": "records", "auth_type": "basic", "auth_value": "base64-encoded-credentials", "batch_size": 100 }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Kinesis theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-kinesis-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "kinesis", "stream_arn": "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream", "access_key_id": "AKIAIOSFODNN7EXAMPLE", "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Meilisearch theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-meilisearch-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "meilisearch", "endpoint_url": "http://localhost:7700", "index_name": "records", "primary_key": "id", "api_key": "your-api-key", "batch_size": 100, "timeout_seconds": 5 }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Redis String theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-redis-string-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "redis_string", "host": "localhost", "port": 6379, "database": 0, "tls": false, "username": "redis_user", "password": "redis_password", "expire_ms": 3600000, "mode": "static" }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json SNS theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-sns-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "sns", "topic_arn": "arn:aws:sns:us-east-1:123456789012:MyTopic", "region": "us-east-1", "access_key_id": "AKIAIOSFODNN7EXAMPLE", "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "is_fifo": false }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ``` ```json Typesense theme={null} { "data": [ { "id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb", "name": "my-typesense-sink", "status": "active", "database": "my-database", "source": { "include_schemas": null, "exclude_schemas": null, "include_tables": null, "exclude_tables": null }, "tables": [ { "name": "public.products", "group_column_names": ["category"] } ], "actions": ["insert", "update", "delete"], "destination": { "type": "typesense", "endpoint_url": "http://localhost:8108", "collection_name": "records", "api_key": "your-api-key", "batch_size": 100, "timeout_seconds": 5 }, "filter": "none", "transform": "id-transform", "routing": "none", "enrichment": "none", "message_grouping": true, "max_retry_count": null, "annotations": {}, "active_backfills": [], "batch_size": 50, "load_shedding_policy": "pause_on_full", "timestamp_format": "iso8601", "health": { "name": "Consumer health", "status": "healthy", "checks": [ { "name": "Sink configuration", "status": "healthy" }, ... ] } } ] } ```