Skip to main content
GET
List all topics

Authorizations

Authorization
string
header
required

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

Query Parameters

entity_type
string | null

Filter by entity type(s). Single value (e.g., 'sources') or comma-separated (e.g., 'sources,transforms'). Valid types: sources, destinations, transforms, pipelines, manual.

topic_id
string | null
partial_name
string | null

Topic id

page
integer
default:1
page_size
integer
default:10
entity_id
string | null

Filter by specific entity IDs (comma-separated list)

include_dlq
boolean
default:true

Include Dead Letter Queue (DLQ) topics in results. Set to false to exclude DLQ topics.

include_internal
boolean
default:false

Local/admin-app only: include Streamkap/KC internal topics (streamkap_signal, streamkap_state, KC offsets/configs/status) in the result. Internal topics carry connector='internal:'.

snapshot
string | null

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

eta
string | null

Filter by snapshot ETA in milliseconds. Format: 'operator:value' (e.g., 'gt:60000', 'lte:300000'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=). Topics without ETA (null/0) are excluded when filtering.

timestamp_from
string | null

Start timestamp for filtering topics by activity period (ISO 8601 format)

timestamp_to
string | null

End timestamp for filtering topics by activity period (ISO 8601 format)

time_type
enum<string> | null

Time aggregation type for filtering active topics (only applies when timestamp_from/to are specified)

Available options:
timeseries,
timesummary,
latest
value_format
string | null

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Omit or pass null to return all formats.

has_errors
boolean | null

Filter topics by error status. true = only topics with recordErrorTotal > 0, false = only topics with recordErrorTotal == 0, null/omit = return all topics.

orphaned
boolean | null

Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations.

partition_skew
boolean | null

Filter by partition skew. true = only topics where max partition lag > 2x average.

sort
string | null

Sort field. Valid values: DB fields (name, connector, entity_type, entity_name), snapshot_status (sources only), or Kafka-admin fields (partition_count, replication_factor, retention_ms, lastMessageTimestamp).

sort_dir
enum<string>
default:asc
Available options:
asc,
desc
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 /topics/details/search requests.

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

entity_id

List of entity IDs (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

value_format
string | null

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Body takes precedence over query params.

has_errors
boolean | null

Filter topics by error status. true = only topics with errors, false = only topics without errors. Body takes precedence over query params.

orphaned
boolean | null

Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations. Body takes precedence over query params.

partition_skew
boolean | null

Filter by partition skew. true = only topics where max partition lag > 2x average. 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

result
TopicDetailsRes · 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