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:

Value

Description

id

Sort by Item ID (ascending)

title

Sort alphabetically by title

description

Sort alphabetically by description

ordinal

Sort by the Item's ordinal within the Stream

author.full_name

Sort alphabetically by the full name of the Item's author

created_at

Sort by date when Item was created

modified_at

Sort by date when Item was last modified

published_at

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

Property

Type

Description

id

integer

The Item's identifier code

hub_id

integer

The Hub's identifier code

type

string

The Item's content type

service

string

The service from which the Item was imported (“blogpost”, “youtube”, etc.)

title

string

The Item's title

description

string

The Item's description

seo_title

string

The Item's title meta tag

seo_description

string

The Item's description meta tag

url

string

The Item's URL

thumbnail_url

string

The URL of the Item's thumbnail image

canonical_url

string

The Item's canonical URL

mediaproxy_thumbnail_url

string

The URL of the Item's thumbnail on Uberflip's mediaproxy

published

boolean

Whether the Item is set to published

featured

boolean

Whether the Item is set to featured

hidden

boolean

Whether the Item is set to hidden

edited

boolean

Whether the Item has been edited

deleted

boolean

Whether the Item has been deleted

content

object

An object containing the content of the Item

custom code

object

An object containing Item-level custom code for the Item

author

object

An object containing metadata about the Item's author

external_created_at

date

The externally displayed date when the Item was created

external_modified_at

date

The externally displayed date when the Item was last modified

created_at

date

The date the Item was created

modified_at

date

The date the Item was last modified

published_at

date

The date the Item was published

stream

object

An object containing metadata about the specified Stream

content object properties

The content object in the response contains these properties:

Property

Type

Description

published

string

The full published HTML content of the Item

draft

string

The full draft (unpublished) HTML content of the Item

custom_code object properties

The custom_code object in the response contains these properties:

Property

Type

Description

html

string

The full Item-level HTML custom code applied to this Item

css

string

The full Item-level CSS custom code applied to this Item

js

string

The full Item-level JavaScript custom code applied to this Item

author object properties

The author object in the response contains these properties:

Property

Type

Description

id

integer

The identifier code of the user who authored the Item

first_name

string

The author's first name as set on their user profile

last_name

string

The author's last name as set on their user profile

full_name

string

The author's combined first and last name

username

string

The author's username as set on their user profile

email

string

The author's email address as set on their user profile

company

string

The author's company as set on their user profile

bio

string

The author's biographical text as set on their user profile

twitter_id

string

The author's Twitter handle as set on their user profile

avatar_url

string

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

Property

Type

Description

id

integer

The Stream's identifier code

title

string

The Stream's title

ordinal

integer

The Item's ordinal in the Stream

meta object properties

The meta object contains pagination metadata.

Language
Authentication
OAuth2