View

View information about one or more playlists

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • playlist-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
playlist Hash   Only show the playlist with the given hash
user Hash   Only show the playlists of the given user
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String created

Defines the field to order the results by; can be any of the following:

  • title – Order lexicographically by title
  • created – Order by the date when the item was created
  • modified – Order by the date when the item was last modified
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Playlist ID
user

User this playlist belongs to

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
account

Account this playlist belongs to

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
title String Title of the playlist
description String Description of the playlist
externallink String A link to an external page, such as a page containing more information about this playlist, or the page where this playlist is embedded
entries

Entries in this playlist. Each entry contains either an item or a livestream

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
position Integer The sort order of this entry
skippable Boolean Is this playlist entry skippable
maxplaytime Duration The maximum play time for this playlist entry. Only useful for livestreams
item

The item of this entry, if any

The value of this field is an object containing the following fields:

Name Type Description
id Hash Item ID
title String Title of the item
description String Description of the item
type Label The type of this item; for available item types, refer to the documentation of the Item command
account

The account that created this item

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
datecreated DateTime When this item was created; for recordings of live-events, this is the date when the item finished recording
livestream

The livestream of this entry, if any

The value of this field is an object containing the following fields:

Name Type Description
id Hash Livestream ID
title String Title of the live stream
description String Description of the live stream
type Label The type of this livestream; for available livestream types, refer to the documentation of the Livestream command
deletedentity Boolean Whether the item or livestream for this entity is deleted

Errors

This action will always return one of the default status codes.