Sign in

v50

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-2810050281.4 KB
Playlists

Get Playlists

Gets a page of playlist objects for the account

get/v1/accounts/{{account_id}}/playlists

Path parameters

account_idstring required

Video Cloud account ID.

Query parameters

limitinteger
Example:20

Number of items to return - see Paging Search Results for more information

offsetinteger
Example:20

Number of items to skip - see Paging Search Results for more information

qstring
Example:name:%28Really%20Short%20Videos%29%20type:EXPLICIT

Search string - see playlist search guide for details

sort'name' | '-name' | 'updated_at' | '-updated_at'
Example:name

Field to sort results by - if absent and there is a search string, results are sorted by relevance or if there is no search string, results are sorted by -updated_at - note: to sort in descending order, preface the field name with a minus(-) sign. If the q= param is missing, the sort param will be ignored. Also if sort is set to an unsupported field, the quest will fail with an error

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Response

200

account_idstring

Video Cloud account id

created_atstring date-time

date/time created

descriptionstring

playlist description

favoriteboolean

whether playlist is in favorites list

idstring

the playlist id

namestring

the playlist name

reference_idstring

the playlist reference id (must be unique within the account)

searchstring

search string to retrieve the videos (smart playlists only)

state'READY' | 'UPDATING'

Applies to EXPLICIT (manual) playlists only; UPDATING means the list is updating its video members and READY means that all videos have been added

type'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'

the playlist type: EXPLICIT or smart playlist type

updated_atstring date-time

date/time last modified

video_idsstring[]

array of video ids (EXPLICIT playlists only)

Example response

[
  {
    "id": "5716873476001",
    "account_id": "57838016001",
    "created_at": "2018-01-23T12:55:29.674Z",
    "description": "My new sea playlist",
    "favorite": false,
    "name": "Sea Videos",
    "reference_id": null,
    "type": "ACTIVATED_NEWEST_TO_OLDEST",
    "updated_at": "2018-01-23T12:55:29.677Z",
    "limit": 20,
    "search": "+tags:\"birds\""
  }
]