Skip to main content
GET
/
sources
Get Sources
curl --request GET \
  --url https://api.streamkap.com/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector": [
    "<string>"
  ],
  "status": [
    "<string>"
  ],
  "snapshot": [
    "<string>"
  ]
}
'
{
  "result": [
    {
      "name": "<string>",
      "connector": "<string>",
      "id": "<string>",
      "connector_display_name": "<string>",
      "created_timestamp": "<string>",
      "sub_id": "<string>",
      "tenant_id": "<string>",
      "service_id": "<string>",
      "config": {},
      "topic_ids": [
        "<string>"
      ],
      "topic_map": {},
      "topics": [
        "<string>"
      ],
      "tasks": [
        123
      ],
      "connector_status": "<string>",
      "task_statuses": {}
    }
  ],
  "page": 1,
  "page_size": 10,
  "total": 123,
  "has_next": true
}

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_size
integer
default:10
​
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
​
first_seen_offsets
​
id
string | null
​
partial_name
string | null
​
connector
string | null

Filter by connector type. Comma-separated for multiple connectors (e.g., 'postgresql', 'postgresql,mysql,mongodb')

​
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

​
latency
string | null

Filter by latency in milliseconds. Format: 'operator:value' (e.g., 'gt:1000', 'lt:500', 'gte:100'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=)

​
snapshot
string | null

Filter by snapshot status. Comma-separated for multiple statuses (e.g., 'running', 'completed,failed'). Valid statuses: running, completed, failed, pending, cancelled

Body

application/json

Body model for POST /sources requests.

Supports large lists of IDs 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.

​
snapshot

List of snapshot statuses (as array) or comma-separated string. Body takes precedence over query params. Valid statuses: running, completed, failed, pending, cancelled

Response

Successful Response

Get paginated sources response.

​
result
SourceConnector · object[]
required
​
page
integer
default:1
​
page_size
integer
default:10
​
total
integer | null
​
has_next
boolean | null