STstreamkap
Destinations

Get Destinations

Changed on
get/destinations

Request

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Number of results per page (max 100)

sortstring nullable

Sort field. Can be a DB field (name, created_at) or a metric field (latency, connector_status, recordsLag)

sort_dir'asc' | 'desc'

Sort direction for list/pagination requests: asc or desc.

Sort direction: 'asc' (ascending) or 'desc' (descending)

string
OR
object
string
OR
object
idstring nullable
partial_namestring nullable
connectorstring nullable

Filter by connector type. Comma-separated for multiple connectors (e.g., 'snowflake', 'snowflake,bigquery,clickhouse')

statusstring nullable

Filter by connector status. Comma-separated for multiple statuses (e.g., 'Active', 'Active,Paused'). Valid statuses: Active, Broken, Paused, Stopped, Starting, Unassigned, Unknown

lagstring nullable

Filter by consumer lag (records behind). Format: 'operator:value' (e.g., 'gt:100', 'lt:50'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=)

tag_idsstring nullable

Filter by tag IDs. Comma-separated list (e.g., 'tag1,tag2'). Use with tag_filter_operation to control AND/OR logic.

tag_filter_operation'and' | 'or' nullable

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags.

Request body

tag_filter_operation'and' | 'or' nullable

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags. Body takes precedence over query params.

Response

Successful Response

pageinteger

Current page number

page_sizeinteger

Results per page

totalinteger nullable

Total number of results

has_nextboolean nullable

Whether more pages exist

Changes

  • 50e54c2e65f2Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status