Playlists

Get Playlist by ID or Reference ID

Gets a playlist object for an account, based on playlist ID or reference ID. Note that playlists may contain up to 1000 videos. By default, only the first 20 are returned. You can use the limit and offset parameters to control how many (up to 1000) and which videos are returned for a request

get/accounts/{{account_id}}/playlists/{playlist_id}

Path parameters

account_idstring required

Video Cloud account ID

playlist_idstring required

Video Cloud playlist ID

Query parameters

limitinteger

The number of videos to return

offsetinteger

The number of videos to skip - used to page multiple sets of videos. Note that the maximum number of videos that can be returned by the Playback API is 1000. To return more than 1000 videos, you must use the CMS API.

ad_config_idstring

include server-side ad insertion

config_idstring

include and set equal to the delivery rules id in order to have the delivery rules applied

Headers

Authorizationstring required

BCOV-Policy {policy_key} (there are 3 ways to authenticate — use one of these three headers). You need to use a search-enabled Policy Key if you are using the q parameter.

BCOV-Policystring required

BCOV-Policy {policy_key} (there are 3 ways to authenticate — use one of these three headers). You need to use a search-enabled Policy Key if you are using the q parameter.

Acceptstring required

application/json;pk=policy_key (there are 3 ways to authenticate — use one of these three headers) See Policy API Overview or Policy Keys for information on getting policy keys

Response

200

account_idstring

Video Cloud account id

created_atstring

date/time created

descriptionstring

playlist description

idstring

the playlist id

namestring

the playlist name

reference_idstring

the playlist reference id

typestring

the playlist type: EXPLICIT or smart playlist type

updated_atstring

date/time last modified

video_idsstring[]

array of video ids (EXPLICIT playlists only)

searchstring

search string to retrieve the videos (smart playlists only)

Example response

{
  "videos": [
    {
      "description": "Bugs-Bee",
      "poster_sources": [
        {
          "src": "https://cf-images.eu-west-1.prod.boltdns.net/v1/static/1752604059001/a9554ba2-899e-408e-91f6-8bf1a4decfcb/c1e55b4e-4758-4ad3-98ea-ba8feaf0a6f8/1280x720/match/image.jpg"
        }
      ],
      "tags": [
        "bugs",
        "sample"
      ],
      "cue_points": [],
      "custom_fields": {},
      "account_id": "1752604059001",
      "sources": [
        {
          "ext_x_version": "4",
          "type": "application/x-mpegURL",
          "src": "https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/a9554ba2-899e-408e-91f6-8bf1a4decfcb/10s/master.m3u8?fastly_token=NWJiMjZjZGJfYWYyMjFhYmJmNmI3MmM3NWNiYzJmODZiMWVlN2Y1NTA0ZDc5MWIyNTcyYTYyNDk3OWRmNGM2NmRkMzI4Y2I4Ng%3D%3D"
        }
      ],
      "name": "Bugs-Bee",
      "reference_id": "1754261699001",
      "long_description": null,
      "duration": 30000,
      "economics": "AD_SUPPORTED",
      "published_at": "2012-07-25T20:34:13.393Z",
      "text_tracks": [],
      "updated_at": "2018-09-03T18:35:27.609Z",
      "thumbnail": "https://cf-images.eu-west-1.prod.boltdns.net/v1/static/1752604059001/a9554ba2-899e-408e-91f6-8bf1a4decfcb/8e656dae-6331-4cad-9922-6ab39ac44650/160x90/match/image.jpg",
      "poster": "https://cf-images.eu-west-1.prod.boltdns.net/v1/static/1752604059001/a9554ba2-899e-408e-91f6-8bf1a4decfcb/c1e55b4e-4758-4ad3-98ea-ba8feaf0a6f8/1280x720/match/image.jpg",
      "offline_enabled": false,
      "link": null,
      "id": "1754261699001",
      "ad_keys": null,
      "thumbnail_sources": [
        {
          "src": "https://cf-images.eu-west-1.prod.boltdns.net/v1/static/1752604059001/a9554ba2-899e-408e-91f6-8bf1a4decfcb/8e656dae-6331-4cad-9922-6ab39ac44650/160x90/match/image.jpg"
        }
      ],
      "created_at": "2012-07-25T20:34:13.393Z"
    }
  ],
  "updated_at": "2016-01-30T20:43:59.351Z",
  "type": "ACTIVATED_NEWEST_TO_OLDEST",
  "reference_id": "bugs1754200352001",
  "name": "Bugs",
  "id": "1754200352001",
  "description": null,
  "created_at": "2012-07-25T20:43:06.070Z",
  "account_id": "1752604059001"
}

Changes

No recorded changes to this endpoint across all 3 revisions of this API.