Playback API Playlist Fields Reference

Product(s)
Video Cloud
Role(s)
API Developer
Device SDK Developer
Topic(s)
Playback
Playlists
References
API(s)
Playback API

This is a reference to playlist fields returned by the Playback API.

Primary fields

Table 1: Primary Fields
Field Type Default Description
id string none the playlist id
account_id string none the id of the account
created_at ISO 8601 date-time string none date-time video was added to the account; example: "2014-12-09T06:07:11.877Z"
description string null the short description of the video - 128 single-byte characters maximum
favorite boolean false whether the playlist is included in favorites
limit number 100 number of videos the playlist can hold (integer, 1 - 100) returned for Smart Playlists only
name string none Playlist title - required field
reference_id string null any value that is unique within the account
search string null search string used to define the videos for a Smart playlist (example: +tags:"bird","birds")
type string the type of playlist See note[1] below
updated_at ISO 8601 date-time string none date-time playlist was last modified; example: "2015-01-13T17:45:21.977Z"
videos array array of video objects for the videos in the playlist only the first 20 videos are returned for playlists

Notes

  • [1]

    The type value can only be one of: EXPLICIT, ACTIVATED_OLDEST_TO_NEWEST, ACTIVATED_NEWEST_TO_OLDEST, ALPHABETICAL, PLAYS_TOTAL, PLAYS_TRAILING_WEEK, START_DATE_OLDEST_TO_NEWEST,START_DATE_NEWEST_TO_OLDEST

    EXPLICIT means that it is a manual playlist; all the other types are smart playlists with names corresponding to their ordering scheme.