This endpoint returns a paginated list of all the items in a stream.
Parameter values: sort
sort
You can use these values with the sort
query parameter:
Value | Description |
---|---|
| Sort by Item ID (ascending) |
| Sort alphabetically by title |
| Sort alphabetically by description |
| Sort by the Item's ordinal within the Stream |
| Sort alphabetically by the full name of the Item's author |
| Sort by date when Item was created |
| Sort by date when Item was last modified |
| 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
data
object propertiesThe data
object consists of one or more objects, one per result returned. These objects have the following properties:
Property | Type | Description |
---|---|---|
| integer | The Item's identifier code |
| integer | The Hub's identifier code |
| string | The Item's content type |
| string | The service from which the Item was imported (“blogpost”, “youtube”, etc.) |
| string | The Item's title |
| string | The Item's description |
| string | The Item's title meta tag |
| string | The Item's description meta tag |
| string | The Item's URL |
| string | The URL of the Item's thumbnail image |
| string | The Item's canonical URL |
| string | The URL of the Item's thumbnail on Uberflip's mediaproxy |
| boolean | Whether the Item is set to published |
| boolean | Whether the Item is set to featured |
| boolean | Whether the Item is set to hidden |
| boolean | Whether the Item has been edited |
| boolean | Whether the Item has been deleted |
| object | An object containing the content of the Item |
| object | An object containing Item-level custom code for the Item |
| object | An object containing metadata about the Item's author |
| date | The externally displayed date when the Item was created |
| date | The externally displayed date when the Item was last modified |
| date | The date the Item was created |
| date | The date the Item was last modified |
| date | The date the Item was published |
| object | An object containing metadata about the specified Stream |
content
object properties
content
object propertiesThe content
object in the response contains these properties:
Property | Type | Description |
---|---|---|
| string | The full published HTML content of the Item |
| string | The full draft (unpublished) HTML content of the Item |
custom_code
object properties
custom_code
object propertiesThe custom_code
object in the response contains these properties:
Property | Type | Description |
---|---|---|
| string | The full Item-level HTML custom code applied to this Item |
| string | The full Item-level CSS custom code applied to this Item |
| string | The full Item-level JavaScript custom code applied to this Item |
author
object properties
author
object propertiesThe author
object in the response contains these properties:
Property | Type | Description |
---|---|---|
| integer | The identifier code of the user who authored the Item |
| string | The author's first name as set on their user profile |
| string | The author's last name as set on their user profile |
| string | The author's combined first and last name |
| string | The author's username as set on their user profile |
| string | The author's email address as set on their user profile |
| string | The author's company as set on their user profile |
| string | The author's biographical text as set on their user profile |
| string | The author's Twitter handle as set on their user profile |
| string | The URL for the author's avatar image as set on their user profile |
stream
object properties
stream
object propertiesThe stream
object in the response contains these properties:
Property | Type | Description |
---|---|---|
| integer | The Stream's identifier code |
| string | The Stream's title |
| integer | The Item's ordinal in the Stream |
meta
object properties
meta
object propertiesThe meta
object contains pagination metadata.