Skip to main content
GET
Returns a list of all sink consumers.

Response fields

data[]
Where data is an array of objects with the following fields:
string
The unique identifier of the sink consumer
string
The name of the sink consumer
string
The current status of the sink consumer (active, disabled, paused)
string
The source database for the sink consumer
object
The source configuration for the sink consumer. This determines which tables are consumed.
array
Additional configuration for individual tables.To configure which tables are consumed, see the source field.
array
The database actions to include in the sink (insert, update, delete)
object
The destination configuration for the sink consumer. The shape varies by destination type.
string
The filter function for the sink consumer
string
The transform function for the sink consumer
string
The routing function for the sink consumer
string
The enrichment function for the sink consumer
boolean
Whether message grouping is enabled for delivery orderingSee message grouping and ordering for more details.
integer
The maximum number of times a message will be retried if delivery fails
object
User-defined annotations for the sink consumer
array
Array of active backfill IDs
integer
Number of records to batch together (1-1000)
string
Determines how Sequin handles overload when sink consumers can’t keep up with incoming messages
string
The format of the timestamp in the source data
object
Health status information for the sink consumer