Get an existing standard playlist

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Playlists/{id}

The active version is only displayed if it is released.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
id
integer (int32) Required

Unique ID of the playlist

version
stringRequired

The requested API version

Default"1.18"
Query parameters
includeAllVersions
boolean

If true, the property Versions is populated. Default: false.

includeTags
boolean

If true, the property Tags is populated. Default: false.

Responses
200

OK

Expand All
object

Playlist response model with detailed user group permissions

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 the playlist

property*
object additionalProperties
Read
boolean
Write
boolean
CopyContent
boolean
Approve
boolean
VideoExport
boolean
ReceiveMessage
boolean
Tags
Array of object (V1.Models.Playlist.Tag)

Tags of the playlist

object

Playlist tag

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the tag

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the tag

ParentId
integer (int32)

Unique ID of the parent tag

Permissions
object

Permissions of the tag

Read
boolean
Write
boolean
Type
string

Type of the tag

Valid values[ "Standard", "LiveTag", "SyncTag", "ConflictTag", "StartOfCommunication" ]
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
404

Not found

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