Get Hubs for Stream

Gets the details of Hubs in which a specified Stream appears.

Parameter values: sort

You can use these values with the sort query parameter:

ValueDescription
idSort by Hub identifier code (asc)
nameSort by Hub name (alpha)
introductionSort by Hub introduction text (alpha)
descriptionSort by Hub description text (alpha)
stream_countSort by number of Streams in the Hub (desc)
created_atSort by Hub creation date (newest)
modified_atSort by date on which Hub was last modified (newest)

Note: Add - before the value to have the response returned in descending/reverse-alphabetical order.

Returns

Returns a collection of Hubs. The response body consists of two objects, data and meta.

data object properties

The data object consists of one or more objects, one per result returned. These objects have the following properties:

PropertyTypeDescription
idintegerThe Hub's identifier code
namestringThe name of the Hub
introductionstringThe Hub's introduction text
descriptionstringThe Hub's description text
urlstringThe URL of the Hub home page
stream_countintegerThe number of Streams in the Hub
no_robotsbooleanWhether the Hub's no robots meta tag is enabled
template_dataobjectAn object containing metadata about the status of various options on the Hub
created_atdateThe date the Hub was created
modified_atdateThe date the Hub was last updated/changed

template_data object properties

The template_data object in the response contains these properties:

PropertyTypeDescription
open_topbooleanWhether the Open Items in top frame embed setting is enabled
open_flipbooks_topbooleanWhether the Open all Flipbooks in top frame embed setting is enabled
load_more_buttonbooleanWhether the Load content by "See more" button setting is enabled
auth_custom_htmlbooleanWhether the ability to use custom HTML on the Hub is enabled
auth_custom_cssbooleanWhether the ability to use custom CSS on the Hub is enabled
ui_top_menubooleanWhether the Menu Style setting is set to Top Menu (true) or Left Menu (false)
ui_permanent_headerbooleanWhether the Permanent (and shorter) Hero Hubs Lab setting is enabled
ui_no_headerbooleanWhether the Remove Hero Hubs Lab setting is enabled
ui_sticky_footerbooleanWhether the Sticky Footer Hubs Lab setting is enabled
ui_next_flyoutbooleanWhether the Next Item Flyout Hubs Lab setting is enabled
ui_highlightbooleanWhether the Highlight first Item Hubs Lab setting is enabled
ui_iframe_no_navbooleanWhether the Hide banner on iFrame embed Hubs Lab setting is enabled
`ui_theme_darkbooleanWhether the Dark Theme Hubs Lab setting is enabled
ui_nav_always_topbooleanWhether the Always Display Top Banner Hubs Lab setting is enabled

meta object properties

The meta object contains pagination metadata.

Language
Authentication
OAuth2