List Hubs

This endpoint returns a paginated list of all the hubs.

Request

GET https://v2.api.uberflip.com/hubs
Query Parameters Description
query

Return only results containing the specified text in one or more of the following fields:

  • name
  • url
limit Number of results to return
page Page to show
sort

Sort results by one or more of the following fields:

  • id
  • name
  • introduction
  • description
  • stream_count
  • created_at
  • modified_at

Response

The response will contain a hubs collection:

Body Parameters Type Description
data Array The collection of hubs
meta Object See: Pagination

Each hub in the collection will have properties:

Body Parameters Properties Type Description
id   Integer The hub identifier
name   String The hub name
introduction   String The hub introduction
description   String The hub description
url   String The hub URL
stream_count   Integer The number of streams in the hub
no_robots   Boolean Whether the hub allows robots
template_data   Object  
-> open_top Boolean Whether the hub has open top
-> open_flipbooks_top Boolean Whether the hub has open flipbooks top
-> load_more_button Boolean Whether the hub loads additional buttons
-> auth_custom_html Boolean Whether the hub allows custom HTML
-> auth_custom_css Boolean Whether the hub allows custom CSS
-> ui_top_menu Boolean Whether the hub has top menu
-> ui_permanent_header Boolean Whether the hub has a permanent header
-> ui_no_header Boolean Whether the hub has no header
-> ui_sticky_footer Boolean Whether the hub has a sticky footer
-> ui_next_flyout Boolean Whether the hub has a flyout
-> ui_highlight Boolean Whether the hub has highlights
-> ui_iframe_no_nav Boolean Whether the hub is embedded in an iframe
-> ui_theme_dark Boolean Whether the hub has dark theme
-> ui_nav_always_top Boolean Whether the hub navigations are always on top
created_at   Date The hub created date
modified_at   Date The hub last modified date

Examples

curl -H "Authorization: Bearer [Token]" \
-i https://v2.api.uberflip.com/hubs

Sample response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": 24601,
            "name": "Uberflip",
            "introduction": "Welcome to our Hub",
            "description": "Welcome to our Hub! We hope you find something interesting to read, watch and share.",
            "url": "http://hub.uberflip.com/h/",
            "stream_count": 1,
            "no_robots": false,
            "template_data": {
                "open_top": false,
                "open_flipbooks_top": false,
                "load_more_button": false,
                "auth_custom_html": false,
                "auth_custom_css": false,
                "ui_top_menu": false,
                "ui_permanent_header": false,
                "ui_no_header": false,
                "ui_sticky_footer": false,
                "ui_next_flyout": false,
                "ui_highlight": false,
                "ui_iframe_no_nav": false,
                "ui_theme_dark": false,
                "ui_nav_always_top": false
            },
            "created_at": "2014-10-08T17:25:44-0400",
            "modified_at": "2015-09-17T20:07:28-0400"
        },
    ],
    "meta":
    {
        ...
    }
}