Get an existing standard playlist

Published on Aug 7, 2026

Prev Next

Get

/v{version}/Playlists/{id}

The active version is only displayed if it is released.

Security

API Key: api_key

Header parameter nameX-ApiKey

Api Key

API Key: session_id

Header parameter nameX-Session-Id

Session Id

Path parameters

integer (int32) Required

Unique ID of the playlist

version

stringRequired

The requested API version

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

Returns the playlist.

Expand All

object

Playlist response model with detailed user group permissions

ActiveVersion

object (V1.Models.Playlist.Version)

Playlist version

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

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

ValidFrom

string (date-time)

Valid from date of the playlist version

Example2023-01-25T09:08:03.747Z

ValidTo

string (date-time)

Valid to date of the playlist version

Example2023-01-25T09:08:03.747Z

Created

string (date-time)

Creation date in UTC

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

A set containing multiple entries containing one user group and its available permissions

Read

boolean

Write

boolean

CopyContent

boolean

Approve

boolean

VideoExport

boolean

ReceiveMessage

boolean