---
title: "Get comprehensive topic information"
method: GET
path: "/topics/{topic_id}"
tags: ["Topics"]
---

# Get comprehensive topic information

`GET /topics/{topic_id}`

## Path parameters

- `topic_id` string, required

## Query parameters

- `detailed` boolean

## Response `200`

Successful Response

- union
  - TopicDetailsWithKafka — Topic details with live Kafka information.
    - `id` string, required
    - `name` string, required
    - `entity` TopicDetailsEntity, required
      - `entity_type` 'sources' | 'destinations' | 'transforms' | 'pipelines' | 'manual', required — Enum for topic entity types (producer types).
      - `entity_id` string, required
      - `name` string, required
      - `connector` union, required
        - 'alloydb' | 'elasticsearch' | 'mongodbhosted' | 'mongodb' | 'sqlserveraws' | 'mariadb' | 'mysql' | 'postgresql' | 'oracle' | 'documentdb' | 'oracleaws' | 'kafkadirect' | 'redis' | 's3' | 'webhook' | 'zendesk_webhook' | 'salesforce_webhook' | 'shopify_webhook' | 'stripe_webhook' | 'db2' | 'dynamodb' | 'vitess' | 'planetscale' | 'supabase' | 'informix' — Available source connector types for CDC data ingestion. Includes relational databases (PostgreSQL, MySQL, SQL Server, Oracle), NoSQL databases (MongoDB, DynamoDB), and direct Kafka connections.
        - 'azblob' | 'clickhouse' | 'databricks' | 'mysql' | 'postgresql' | 'redshift' | 's3' | 'r2' | 'gcs' | 'motherduck' | 'weaviate' | 'pinecone' | 'httpsink' | 'sqlserver' | 'bigquery' | 'cockroachdb' | 'db2' | 'oracle' | 'redis' | 'snowflake' | 'starburst' | 'kafka' | 'kafkadirect' | 'iceberg' — Available destination connector types for data delivery. Supports data warehouses (Snowflake, BigQuery, Databricks), databases (ClickHouse, PostgreSQL), and object storage (S3, Iceberg).
        - 'fan_out' | 'sql_join' | 'enrich' | 'enrich_async' | 'map_filter' | 'toast_handling' | 'un_nesting' | 'rollup' | 'topic_router'
        - string
      - `topic_ids` string[], required
      - `topic_db_ids` string[], required
      - `display_name` string, required
      - `filtered_snapshot_language` string, nullable
    - `prefix` string, nullable
    - `serialization` TopicSerialization — Serialization format information for a topic. Topics inherit their serialization format from their producer (source/transform). Most Streamkap sources use Avro by default with Schema Registry.
      - `key_format` 'avro' | 'json' | 'json_schema' | 'protobuf' | 'string' | 'bytearray' | 'unknown' — Human-readable serialization format names for API responses.
      - `value_format` 'avro' | 'json' | 'json_schema' | 'protobuf' | 'string' | 'bytearray' | 'unknown' — Human-readable serialization format names for API responses.
      - `key_converter` string, nullable — Converter class for message keys
      - `value_converter` string, nullable — Converter class for message values
      - `schema_registry_enabled` boolean — Whether Schema Registry is used for this topic's serialization
    - `tags` string[], nullable — List of tag IDs assigned to this topic
    - `broker_only` boolean — True when this row was surfaced from a broker listing rather than the MongoDB `topics` collection (only possible with `include_internal=true`). The FE renders a badge so the user can tell Mongo-tracked topics apart from broker-only ones.
    - `kafka` TopicKafkaMetadata, required — Live Kafka metadata for a topic.
      - `partitions` TopicKafkaPartitions, required — Kafka partition information for a topic.
        - `count` integer, required
        - `replication_factor` integer, required
        - `under_replicated_count` integer, required
        - `offline_count` integer, required
        - `details` PartitionDetail[], required
          - `partition_id` integer, required
          - `replicas` integer[], required
          - `in_sync_replicas` integer[], required
          - `is_under_replicated` boolean, required
          - `is_offline` boolean, required
      - `configs` TopicKafkaConfigs, required — Customer-relevant Kafka configuration properties.
        - `retention_ms` string, nullable
        - `retention_bytes` string, nullable
        - `cleanup_policy` string, nullable
        - `delete_retention_ms` string, nullable
        - `max_message_bytes` string, nullable
        - `compression_type` string, nullable
        - `min_insync_replicas` string, nullable
        - `segment_ms` string, nullable
        - `segment_bytes` string, nullable
        - `unclean_leader_election` string, nullable
        - `message_timestamp_type` string, nullable
      - `health` TopicKafkaHealth, required — Topic health indicators.
        - `is_healthy` boolean, required
        - `under_replicated_partitions` integer, required
        - `offline_partitions` integer, required
        - `total_replicas` integer, required
        - `in_sync_replicas` integer, required
      - `serialization` TopicSerialization — Serialization format information for a topic. Topics inherit their serialization format from their producer (source/transform). Most Streamkap sources use Avro by default with Schema Registry.
        - `key_format` 'avro' | 'json' | 'json_schema' | 'protobuf' | 'string' | 'bytearray' | 'unknown' — Human-readable serialization format names for API responses.
        - `value_format` 'avro' | 'json' | 'json_schema' | 'protobuf' | 'string' | 'bytearray' | 'unknown' — Human-readable serialization format names for API responses.
        - `key_converter` string, nullable — Converter class for message keys
        - `value_converter` string, nullable — Converter class for message values
        - `schema_registry_enabled` boolean — Whether Schema Registry is used for this topic's serialization
  - object

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/streamkap/apis/streamkap-rest-api.md) · [All operations](https://skmtc.net/streamkap/apis/streamkap-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/streamkap/streamkap-rest-api/versions/8aea6143d003/schema)