Get

/v{version}/Playlists

The active version of a playlist is only displayed if it is released. If you specify a value, only playlists that have the same name (case-insensitive) are returned. If you don't specify a value (default), playlists are returned regardless of their name.

Security

API Key

Header parameter nameX-ApiKey

Api Key

API Key

Header parameter nameX-Session-Id

Session Id

Path parameters

version

stringRequired

The requested API version

Default"1.18"

Query parameters

includeAllVersions

boolean

If true, the property Versions is populated with all versions of the playlist Default: false.

name

stringRequired

Name of the playlist

Responses

200

OK

Array of object

object

Playlist

ActiveVersion

object (V1.Models.Playlist.Version)

Playlist version

Id

integer (int32)

Unique ID of the playlist version

Name

string

Name of the playlist version

PlaylistId

integer (int32)

Playlist ID of the playlist version

Status

string

Status of the playlist version

Valid values[ "Unreleased", "Released", "ApprovalPending" ]

ValidFrom

string (date-time)

Valid from date of the playlist version

ValidTo

string (date-time)

Valid to date of the playlist version

Created

string (date-time)

Creation date in UTC

Id

integer (int32)

Unique ID of playlist

Modified

string (date-time)

Modification date in UTC

Name

string

Name of playlist

Permissions

object

Permissions of playlist

Read

boolean

Write

boolean

CopyContent

boolean

Approve

boolean

VideoExport

boolean

ReceiveMessage

boolean

Versions

Array of object (V1.Models.Playlist.Version)

Playlist versions of the playlist

object

Playlist version

Id

integer (int32)

Unique ID of the playlist version

Name

string

Name of the playlist version

PlaylistId

integer (int32)

Playlist ID of the playlist version

Status

string

Status of the playlist version

Valid values[ "Unreleased", "Released", "ApprovalPending" ]

ValidFrom

string (date-time)

Valid from date of the playlist version

ValidTo

string (date-time)

Valid to date of the playlist version

400

Bad request

Expand All

object

ValidationErrors

object

property*

Array of string additionalProperties

string

403

Access denied

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties

500

Unexpected error

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties