List Items in Stream

get

https://v2.api.uberflip.com/streams/{streamId}/items

This endpoint returns a paginated list of all Items in a Stream.

Path Params

streamId

integer

required

The ID code that identifies the Stream.

Query Params

query

string

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

id
title
description
content

tagged_with

string

Specify comma-separated list of Tags to filter for Items containing all of them.

tagged_with_or

string

Specify comma-separated list of Tags to filter for Items containing at least one of them.

service

string

enum

Specify a service to return only results matching that service . See the table below for accepted values.

blogpost: Blog Items
youtube: YouTube Items
vimeo: Vimeo Items
wistiar: Wistia Items (note wistiar not wistia)
vidyard: Vidyard Items
brightcove: Brightcove Items
twitter: Twitter Items
facebook: Facebook Items
instagram: Instagram Items
uberflip: Flipbook Items
slideshare: SlideShare Items
custom: Marketing Items
targeted: Sales Items

type

string

enum

Specify a type to return only results matching that category. See the table below for accepted values.

blogs: Blog Items
videos: Video Items (YouTube, Vimeo, Wistia, Vidyard, Brightcove)
docs: Document Items (Flipbooks, SlideShare)
social: Social Network Items (Twitter, Facebook, Instagram)
custom: Marketing Items
targeted: Sales Items
featured: Featured Items

Allowed:

featured

boolean

Specify whether to return only Items that are featured (true) or not featured (false).

hidden

boolean

Specify whether to return only Items that are hidden (true) or not hidden (false).

published

boolean

Specify whether to return only Items that are published (true) or not published (false).

deleted

string

enum

Specify whether to include deleted Items (included) or only return deleted Items (only). If not set, deleted Items will not be included.

Allowed:

author_user_id

integer

Specify whether to return Items belonging to Hubs created by the user with the specified ID.

sort

string

Specify the field that should be used to sort the returned Streams. See the table below for accepted sort values. Sort order will be either ascending or alphabetical depending on the field specified.

id: Sort by Item ID
title: Sort by Item title
description: Sort by Item description text
ordinal: Sort by the Item's ordinal within the Stream
author.full_name: Sort by the full names of Item authors
created_at: Sort by Item creation date
modified_at: Sort by Item last modified date
published_at: Sort by Item publish date

include_tags

boolean

Whether to include the tags property for each Item (true) or not (false)

limit

integer

1 to 100

Defaults to 25

Set the number of results returned per page. Defaults to 25 if not set.

page

integer

≥ 1

Defaults to 1

Specify the page of results to be returned. Defaults to 1 if not set.

Response

200200