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:

Value

Description

id

Sort by Hub identifier code (asc)

name

Sort by Hub name (alpha)

introduction

Sort by Hub introduction text (alpha)

description

Sort by Hub description text (alpha)

stream_count

Sort by number of Streams in the Hub (desc)

created_at

Sort by Hub creation date (newest)

modified_at

Sort 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:

Property

Type

Description

id

integer

The Hub's identifier code

name

string

The name of the Hub

introduction

string

The Hub's introduction text

description

string

The Hub's description text

url

string

The URL of the Hub home page

stream_count

integer

The number of Streams in the Hub

no_robots

boolean

Whether the Hub's no robots meta tag is enabled

template_data

object

An object containing metadata about the status of various options on the Hub

created_at

date

The date the Hub was created

modified_at

date

The date the Hub was last updated/changed

template_data object properties

The template_data object in the response contains these properties:

Property

Type

Description

open_top

boolean

Whether the Open Items in top frame embed setting is enabled

open_flipbooks_top

boolean

Whether the Open all Flipbooks in top frame embed setting is enabled

load_more_button

boolean

Whether the Load content by "See more" button setting is enabled

auth_custom_html

boolean

Whether the ability to use custom HTML on the Hub is enabled

auth_custom_css

boolean

Whether the ability to use custom CSS on the Hub is enabled

ui_top_menu

boolean

Whether the Menu Style setting is set to Top Menu (true) or Left Menu (false)

ui_permanent_header

boolean

Whether the Permanent (and shorter) Hero Hubs Lab setting is enabled

ui_no_header

boolean

Whether the Remove Hero Hubs Lab setting is enabled

ui_sticky_footer

boolean

Whether the Sticky Footer Hubs Lab setting is enabled

ui_next_flyout

boolean

Whether the Next Item Flyout Hubs Lab setting is enabled

ui_highlight

boolean

Whether the Highlight first Item Hubs Lab setting is enabled

ui_iframe_no_nav

boolean

Whether the Hide banner on iFrame embed Hubs Lab setting is enabled

`ui_theme_dark

boolean

Whether the Dark Theme Hubs Lab setting is enabled

ui_nav_always_top

boolean

Whether the Always Display Top Banner Hubs Lab setting is enabled

meta object properties

The meta object contains pagination metadata.

Language
Authentication
OAuth2