CMS API Playlist Fields Reference

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

Primary fields

Table 1: Primary Fields
Field Type Read-only Default Description
id string yes none the playlist id
account_id string yes none the id of the account
created_at ISO 8601 date-time string yes none date-time playlist was added to the account; example: "2014-12-09T06:07:11.877Z"
description string no null the short description of the playlist - 248 single-byte characters maximum
favorite boolean no false whether the playlist is included in favorites
limit number no 1000 number of videos the playlist can hold (integer, 1 - 1000) returned for Smart Playlists only
name string no none Playlist title - required field (maximum length: 248 single-byte characters)
reference_id string no null any value that is unique within the account
search string no null search string used to define the videos for a Smart playlist (example: "+tags:"bird","birds"")
search_syntax string no v1 the search syntax (v1) used for a smart playlist search string - see Managing Playlists
state string yes the state of an EXPLICIT (manual) playlist UPDATING means the list is updating its video members and READY means that all videos have been added
type string yes the type of playlist See note[1] below
updated_at ISO 8601 date-time string yes none date-time playlist was last modified;[1-2] example: "2015-01-13T17:45:21.977Z"
video_ids array no array of ids for the videos in the playlist Returned for Manual Playlists only

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.