Skip to main content
POST
/
destinations
/
search
Search destinations (POST)
curl --request POST \
  --url https://api.streamkap.com/destinations/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector": [
    "<string>"
  ],
  "status": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ],
  "tag_filter_operation": "and"
}
'
{
  "result": [
    {
      "name": "<string>",
      "connector": "<string>",
      "id": "<string>",
      "connector_display_name": "<string>",
      "created_timestamp": "<string>",
      "sub_id": "<string>",
      "tenant_id": "<string>",
      "config": {
        "azblob.connection.string.user.defined": "<string>",
        "azblob.container.name": "<string>",
        "format.user.defined": "json",
        "format.csv.write.headers": false,
        "topics.dir": "<string>",
        "file.name.template": "{{topic}}-{{partition}}-{{start_offset}}",
        "flush.size": 1000,
        "file.size": 65536,
        "rotate.interval.ms": -1,
        "compression": "<string>"
      },
      "topic_ids": [
        "<string>"
      ],
      "topic_map": {},
      "topics": [
        "<string>"
      ],
      "tasks": [
        123
      ],
      "connector_status": "<string>",
      "desired_state": "<string>",
      "kc_cluster_id": "<string>",
      "task_statuses": {},
      "tags": [
        "<string>"
      ]
    }
  ],
  "page": 1,
  "page_size": 10,
  "total": 123,
  "has_next": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

​
page_size
integer
default:10

Number of results per page (max 100)

​
sort
string | null

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

​
sort_dir
enum<string>
default:asc

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

Available options:
asc,
desc
​
last_seen_offsets

Last seen offsets for topic messages pagination (cursor-based)

​
first_seen_offsets

First seen offsets for topic messages pagination (cursor-based)

​
id
string | null
​
partial_name
string | null
​
connector
string | null

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

​
status
string | null

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

​
lag
string | null

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

​
tag_ids
string | null

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

​
tag_filter_operation
enum<string> | null
default:or

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

Available options:
and,
or

Body

application/json

Body model for POST /destinations/search requests.

Supports large lists of filter values that would exceed URL length limits when using GET. Body parameters take precedence over query parameters when both are provided.

​
connector

List of connector types (as array) or comma-separated string. Body takes precedence over query params.

​
status

List of statuses (as array) or comma-separated string. Body takes precedence over query params.

​
tag_ids

List of tag IDs (as array) or comma-separated string. Body takes precedence over query params.

​
tag_filter_operation
enum<string> | null

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

Available options:
and,
or

Response

Successful Response

Get paginated destinations response.

​
result
DestinationConnector · object[]
required
​
page
integer
default:1

Current page number

​
page_size
integer
default:10

Results per page

​
total
integer | null

Total number of results

​
has_next
boolean | null

Whether more pages exist