List Items in Stream

This endpoint returns a paginated list of all the items in a stream.

Parameter values: sort

You can use these values with the sort query parameter:

ValueDescription
idSort by Item ID (ascending)
titleSort alphabetically by title
descriptionSort alphabetically by description
ordinalSort by the Item's ordinal within the Stream
author.full_nameSort alphabetically by the full name of the Item's author
created_atSort by date when Item was created
modified_atSort by date when Item was last modified
published_atSort by date when Item was published

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

Returns

Returns the details of Items in the specified Stream. 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 Item's identifier code
hub_idintegerThe Hub's identifier code
typestringThe Item's content type
servicestringThe service from which the Item was imported (“blogpost”, “youtube”, etc.)
titlestringThe Item's title
descriptionstringThe Item's description
seo_titlestringThe Item's title meta tag
seo_descriptionstringThe Item's description meta tag
urlstringThe Item's URL
thumbnail_urlstringThe URL of the Item's thumbnail image
canonical_urlstringThe Item's canonical URL
mediaproxy_thumbnail_urlstringThe URL of the Item's thumbnail on Uberflip's mediaproxy
publishedbooleanWhether the Item is set to published
featuredbooleanWhether the Item is set to featured
hiddenbooleanWhether the Item is set to hidden
editedbooleanWhether the Item has been edited
deletedbooleanWhether the Item has been deleted
contentobjectAn object containing the content of the Item
custom codeobjectAn object containing Item-level custom code for the Item
authorobjectAn object containing metadata about the Item's author
external_created_atdateThe externally displayed date when the Item was created
external_modified_atdateThe externally displayed date when the Item was last modified
created_atdateThe date the Item was created
modified_atdateThe date the Item was last modified
published_atdateThe date the Item was published
streamobjectAn object containing metadata about the specified Stream

content object properties

The content object in the response contains these properties:

PropertyTypeDescription
publishedstringThe full published HTML content of the Item
draftstringThe full draft (unpublished) HTML content of the Item

custom_code object properties

The custom_code object in the response contains these properties:

PropertyTypeDescription
htmlstringThe full Item-level HTML custom code applied to this Item
cssstringThe full Item-level CSS custom code applied to this Item
jsstringThe full Item-level JavaScript custom code applied to this Item

author object properties

The author object in the response contains these properties:

PropertyTypeDescription
idintegerThe identifier code of the user who authored the Item
first_namestringThe author's first name as set on their user profile
last_namestringThe author's last name as set on their user profile
full_namestringThe author's combined first and last name
usernamestringThe author's username as set on their user profile
emailstringThe author's email address as set on their user profile
companystringThe author's company as set on their user profile
biostringThe author's biographical text as set on their user profile
twitter_idstringThe author's Twitter handle as set on their user profile
avatar_urlstringThe URL for the author's avatar image as set on their user profile

stream object properties

The stream object in the response contains these properties:

PropertyTypeDescription
idintegerThe Stream's identifier code
titlestringThe Stream's title
ordinalintegerThe Item's ordinal in the Stream

meta object properties

The meta object contains pagination metadata.

Language
Authentication
OAuth2