> ## 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.

# Browse topics grouped by source

> Get topics grouped by source connector for the SQL Studio tree sidebar.



## OpenAPI

````yaml /openapi/openapi.json get /topics/catalog/grouped
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Agents
    description: Create, deploy, and manage Flink-based AI agents.
  - name: Agents Observability
    description: >-
      Read-only views over the MCP audit log: agent rollup, sessions, spans,
      histograms, external-agent verify.
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /topics/catalog/grouped:
    get:
      tags:
        - Topics
      summary: Browse topics grouped by source
      description: Get topics grouped by source connector for the SQL Studio tree sidebar.
      operationId: getTopicCatalogGrouped
      parameters:
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Partial topic name search
            title: Search
          description: Partial topic name search
        - name: source_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter to a single source/producer ID
            title: Source Id
          description: Filter to a single source/producer ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaTopicCatalogGroupedRes'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    KafkaTopicCatalogGroupedRes:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/KafkaTopicCatalogGroup'
          type: array
          title: Groups
        total_topics:
          type: integer
          title: Total Topics
          default: 0
        total_groups:
          type: integer
          title: Total Groups
          default: 0
      additionalProperties: true
      type: object
      title: KafkaTopicCatalogGroupedRes
      description: Grouped catalog response - sources with their topics.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    KafkaTopicCatalogGroup:
      properties:
        group_id:
          type: string
          title: Group Id
          description: Producer entity ID (or '__dlq__' for DLQ group)
        group_name:
          type: string
          title: Group Name
          description: Display name for the group
        group_type:
          type: string
          title: Group Type
          description: 'Producer type: sources, destinations, transforms, dlq, manual'
        connector:
          anyOf:
            - type: string
            - type: 'null'
          title: Connector
          description: Connector type (postgresql, snowflake, etc.)
        topic_count:
          type: integer
          title: Topic Count
          default: 0
        topics:
          items:
            $ref: '#/components/schemas/KafkaTopicCatalogGroupTopic'
          type: array
          title: Topics
      additionalProperties: true
      type: object
      required:
        - group_id
        - group_name
        - group_type
      title: KafkaTopicCatalogGroup
      description: A source/producer group in the catalog tree.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    KafkaTopicCatalogGroupTopic:
      properties:
        topic_id:
          type: string
          title: Topic Id
          description: Full Kafka topic name
        short_name:
          type: string
          title: Short Name
          description: Display name with source prefix stripped (e.g., public.users)
        partition_count:
          type: integer
          title: Partition Count
          default: 0
        value_format:
          $ref: '#/components/schemas/SerializationFormatEnum'
          default: unknown
        is_dlq:
          type: boolean
          title: Is Dlq
          description: Whether this is a dead letter queue topic
          default: false
      additionalProperties: true
      type: object
      required:
        - topic_id
        - short_name
      title: KafkaTopicCatalogGroupTopic
      description: >-
        Lightweight topic entry inside a group (no schema - fetched lazily on
        expand).
    SerializationFormatEnum:
      type: string
      enum:
        - avro
        - json
        - json_schema
        - protobuf
        - string
        - bytearray
        - unknown
      title: SerializationFormatEnum
      description: Human-readable serialization format names for API responses.
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````