STstreamkap
Topics

List topics grouped by connector/entity

Changed on

Get topics grouped by entity_id (connector instances) with nested pagination.

Each group represents a source/transform/destination entity and contains its topics. Supports dual pagination (groups and topics within groups) and dual sorting.

Supports multiple entity types via comma-separated values (e.g., entity_type=sources,transforms). Note: group_id requires exactly one entity_type to be specified.

get/topics/details/grouped

Request

Query parameters

entity_typestring nullable

Filter by entity type(s). Single value (e.g., 'sources') or comma-separated (e.g., 'sources,transforms'). Valid types: sources, destinations, transforms, pipelines, manual, agents. Types given alongside entity_id but owning none of those IDs (e.g. 'agents', which has no picker) match on type alone rather than being AND-ed against the ID list.

pageinteger
page_sizeinteger
topics_per_groupinteger
topics_pageinteger
sort_groups_by'name' | 'connector' | 'topic_count'
sort_groups_dir'asc' | 'desc'
sort_topics_bystring
sort_topics_dir'asc' | 'desc'
partial_namestring nullable
connectorstring nullable
group_idstring nullable

Filter to a specific group/entity_id. Requires exactly one entity_type when used.

group_topic_pagesobject nullable
tag_idsstring nullable

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

tag_filter_operation'and' | 'or' nullable

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

Response

Successful Response

pageinteger

Current page number

page_sizeinteger

Results per page

totalinteger nullable

Total number of results

has_nextboolean nullable

Whether more pages exist

Changes

  • 56dda39bb53cRevision changes
    • warning

      added the new freshdesk enum value to the //// response property for the response status

    • warning

      added the new freshdesk enum value to the /////// response property for the response status

    • warning

      added the new pipedrive enum value to the //// response property for the response status

    • warning

      added the new pipedrive enum value to the /////// response property for the response status

    • warning

      added the new shopify enum value to the //// response property for the response status

    • warning

      added the new shopify enum value to the /////// response property for the response status

  • 50e54c2e65f2Revision changes
    • warning

      added the new agents enum value to the /// response property for the response status

    • warning

      added the new agents enum value to the ////// response property for the response status

    • warning

      added the new facebook_ads enum value to the //// response property for the response status

    • warning

      added the new facebook_ads enum value to the /////// response property for the response status

    • warning

      added the new google_ads enum value to the //// response property for the response status

    • warning

      added the new google_ads enum value to the /////// response property for the response status

    • warning

      added the new google_analytics enum value to the //// response property for the response status

    • warning

      added the new google_analytics enum value to the /////// response property for the response status

    • warning

      added the new hubspot enum value to the //// response property for the response status

    • warning

      added the new hubspot enum value to the /////// response property for the response status

    • warning

      added the new netsuite enum value to the //// response property for the response status

    • warning

      added the new netsuite enum value to the /////// response property for the response status

    • warning

      added the new salesforce enum value to the //// response property for the response status

    • warning

      added the new salesforce enum value to the /////// response property for the response status

    • warning

      added the new stripe enum value to the //// response property for the response status

    • warning

      added the new stripe enum value to the /////// response property for the response status

    • warning

      added the new zendesk enum value to the //// response property for the response status

    • warning

      added the new zendesk enum value to the /////// response property for the response status