List Streams

Gets a (paginated) list of all the Streams in an Uberflip account, as well as metadata about each Stream (such as type, number of Items, etc.).

Parameter values: type

You can use these values with the type query parameter:

Value

Description

blogs

Blog Streams

videos

Video Streams (YouTube, Vimeo, Wistia, Vidyard, Brightcove)

docs

Document Streams (Flipbooks, SlideShare)

social

Social Network Streams (Twitter, Facebook, Instagram)

custom

Marketing Streams

targeted

Sales Streams

Parameter values: service

You can use these values with the service query parameter:

Value

Description

blogpost

Blog Streams

youtube

YouTube Streams

vimeo

Vimeo Streams

wistiar

Wistia Streams (note wistiar not wistia)

vidyard

Vidyard Streams

brightcove

Brightcove Streams

twitter

Twitter Streams

facebook

Facebook Streams

instagram

Instagram Streams

uberflip

Flipbook Streams

slideshare

SlideShare Streams

custom

Marketing Streams

targeted

Sales Streams

Parameter values: sort

You can use these values with the sort query parameter:

Value

Description

id

Sort by Stream identifier code

title

Sort by Stream title

description

Sort by Stream description

item_count

Sort by number of Items in each Stream

created_at

Sort by Stream creation date

modified_at

Sort by date on which Stream was last modified

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

Returns

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

The data object contains the requested records, with these properties:

Property

Type

Description

id

integer

The Stream's identifier code

title

string

The Stream title

description

string

The Stream description

thumbnail_url

string

The URL for the Stream's thumbnail image

type

string

The Stream's category

service

string

The Stream's service type

item_count

integer

The number of Items in the Stream

paused

boolean

Whether the Stream is paused

created_at

date

The Stream's creation date

modified_at

date

The date the Stream was last updated/changed

The meta object contains pagination metadata.

Language
Authentication
OAuth2