Get On Deck Movies

This API command will return all movies that are on deck to be watched next.


GET http://{ip_address}:32400/library/sections/{id}/onDeck?X-Plex-Token={plex_token}


ip_addressThe IP address of the Plex Media server.
plex_tokenThe Plex token.
idThe key associated with a movies library. This key can be found by calling the Libraries API command and looking for a movies library.

Return Status

HTTP CodeDescription
200Success - The request was successful.
401Unauthorized - The Plex token provided was not valid.
404Not Found - The URL path is incorrect. See Remarks below.


XML string value that lists the all the movies in on deck. An example of the XML returned from the request is shown below:

<MediaContainer size="5" allowSync="1" art="/:/resources/movie-fanart.jpg" identifier="com.plexapp.plugins.library" librarySectionID="2" librarySectionTitle="Movies" librarySectionUUID="493a64e7-b541-4667-b050-d702beebf2f6" mediaTagPrefix="/system/bundle/media/flags/" mediaTagVersion="1710434120" sortAsc="1" thumb="/:/resources/movie.png" title1="Movies" title2="On Deck" viewGroup="movie" viewMode="131624">
<Video ratingKey="204868" key="/library/metadata/204868" guid="plex://movie/5d776c0623d5a3001f516b20" slug="dunkirk" studio="Warner Bros. Pictures" type="movie" title="Dunkirk" contentRating="PG-13" summary="The story of the miraculous evacuation of Allied soldiers from Belgium, Britain, Canada and France, who were cut off and surrounded by the German army from the beaches and harbour of Dunkirk between May 26th and June 4th 1940 during World War II." rating="9.2" audienceRating="8.1" viewOffset="1739000" viewCount="7" lastViewedAt="1692499567" year="2017" tagline="When 400,000 men couldn't get home, home came for them." thumb="/library/metadata/204868/thumb/1706866956" art="/library/metadata/204868/art/1706866956" duration="6398293" originallyAvailableAt="2017-07-19" addedAt="1514232066" updatedAt="1706866956" audienceRatingImage="rottentomatoes://image.rating.upright" chapterSource="media" primaryExtraKey="/library/metadata/283127" ratingImage="rottentomatoes://image.rating.ripe">
    <Media id="264424" duration="6398293" bitrate="9886" width="1920" height="1080" aspectRatio="1.78" audioChannels="6" audioCodec="dca" videoCodec="h264" videoResolution="1080" container="mkv" videoFrameRate="24p" audioProfile="dts" videoProfile="high" title="Original">
        <Part id="264754" key="/library/parts/264754/1514244365/file.mkv" duration="6398293" file="M:\Media\Movies\Dunkirk (2017)\Dunkirk (2017) [1080p h.264][AAC DTS DTS-HD].mkv" size="7906730821" audioProfile="dts" container="mkv" videoProfile="high" />
    <Media id="264453" duration="6398315" bitrate="5403" width="1280" height="720" aspectRatio="1.78" audioChannels="6" audioCodec="aac" videoCodec="h264" videoResolution="720" container="mp4" videoFrameRate="24p" optimizedForStreaming="1" proxyType="42" audioProfile="lc" has64bitOffsets="1" target="Custom: Universal TV" videoProfile="high" title="Custom: Universal TV">
        <Part id="264783" key="/library/parts/264783/1514394805/file.mp4" duration="6398315" file="M:\Media\Movies\Dunkirk (2017)\Plex Versions\Custom_ Universal TV 1718\Dunkirk (2017).mp4" size="4321171317" audioProfile="lc" container="mp4" has64bitOffsets="1" optimizedForStreaming="1" videoProfile="high" />
    <Media id="264457" duration="6398315" bitrate="3852" width="1280" height="720" aspectRatio="1.78" audioChannels="2" audioCodec="aac" videoCodec="h264" videoResolution="720" container="mp4" videoFrameRate="24p" optimizedForStreaming="1" proxyType="42" audioProfile="lc" has64bitOffsets="0" target="Optimized for Mobile" targetTagID="6207" videoProfile="high" title="Optimized for Mobile">
        <Part id="264787" key="/library/parts/264787/1514401881/file.mp4" duration="6398315" file="M:\Media\Movies\Dunkirk (2017)\Plex Versions\Optimized for Mobile\Dunkirk (2017).mp4" size="3080471329" audioProfile="lc" container="mp4" has64bitOffsets="0" optimizedForStreaming="1" videoProfile="high" />
    <Genre tag="Action" />
    <Genre tag="Drama" />
    <Country tag="France" />
    <Country tag="Netherlands" />
    <Director tag="Christopher Nolan" />
    <Writer tag="Christopher Nolan" />
    <Role tag="Fionn Whitehead" />
    <Role tag="Tom Hardy" />
    <Role tag="Mark Rylance" />

The XML returned provides a list of the all movies in a library that are available on the Plex server. The root is the MediaContainer element. This element contains a few attributes that provide overall information about the movies on the server.

MediaContainer Attributes
sizeThe number of libraries.
allowSync1 - allow syncing content.
0 - don't allow syncing content.
artBackground artwork used to represent the library.
identifierThe type of item.
librarySectionIDThe unique key associated with the library.
librarySectionTitleThe title of the library.
librarySectionUUIDUnique GUID identifier for the library.
mediaTagPrefixPrefix for the media tag.
mediaTagVersionMedia tag version.
Note: This could be a date and time value.
sortAsc1 - the library is sorted in ascending order.
0 - the library is sorted in descending order.
thumbThe thumbnail for the library.
title1The title of the library.
Note: This appears to be internally created, and can't be changed by the server owner.
title2A descriptive title for the library.
viewGroupThe group type used to view the library.
viewModeUnknown integer value.

Within the MediaContainer there are one or more Video child elements. Each Video element represents one movie available on the Plex server.

Video Attributes
ratingKeyA key associated with the item.
keyThe relative URL of the item information.
guidThe unique identifier comprised of the Plex agent and item identifier for the agent.
slugThe short path name for the item.
studioThe name of the item studio.
typeThe type of media.
titleThe title of the item.
contentRatingThe content rating associated with the item.
summaryA summary of the item.
ratingThe rating for the item.
audienceRatingThe audience rating for the item.
viewOffsetThe current amount of time the item has been played.
viewCountThe number of times the item has been viewed.
lastViewedAtThe date and time for the last time the item was viewed.
yearThe year the item was released.
taglineThe tagline associated with the item.
thumbThe thumbnail for the item.
artThe background artwork used to represent the item.
durationThe length of the item in milliseconds.
originallyAvailableAtThe original release date of the item.
addedAtThe date and time, in Unix time, the item was added to the library.
updatedAtThe date and time in epoch time, the item was updated in the library.
audienceRatingImageThe image associated with the audience rating.
chapterSourceThe chapter source type.
primaryExtraKeyThe extra key value.
ratingImageThe image associated with the rating.

Within the Video there are one or more Media child elements. Each Media element represents one media file of the movie available on the Plex server.

If there are two media files associated with the movie, such as a 1080p and 480p version, then there would be two Media child elements in the Video element.

Media Attributes
idUnique ID associated with the item.
durationThe length of the item in milliseconds.
bitrateThe bitrate of the item.
widthThe width of the item.
heightThe height of the item.
aspectRatioThe aspect ratio of the item.
audioChannelsThe number of audio channels.
audioCodecThe audio codec used to encode the audio.
videoCodecThe video codec used to encode the video.
videoResolutionThe video resolution.
containerThe item container.
videoFrameRateThe framerate standard used for the video.
audioProfileThe audio profile of the media.
videoProfileThe video profile of the media.
titleThe title of the item.

Within the Media there are one or more Part child elements. Each Part element represents one part of the movie. If the movie has been added to the Plex server as a multi-part movie, then each of those parts will be represented by one Part child element.

Part Attributes
idUnique ID associated with the part.
keyThe unique relative path for the part that is used at its key.
durationThe length of the part in milliseconds.
fileThe file associated with the part.
sizeThe file size of the part.
audioProfileThe audio profile associated with the audio part.
containerThe type of media container.
videoProfileThe video profile associated with the video part.

Also within the Video element there are multiple additional child elements that provide more details about the movie. These child elements include Genre, Director, Writer, Country, Collection, and Role.

Within each of these child elements is a single tag attribute that provides the information for the element. There could be multiple of the same child element within the Video, such as multiple directors or writers.

Genre Attributes
tagA genre of the movie.
Director Attributes
tagA director of the movie.
Writer Attributes
tagA writer for the movie
Country Attributes
tagA country of origin for the movie.
Collection Attributes
tagThe name of a collection containing the movie.
Role Attributes
tagThe name of a person with a role in the movie.


When using the command ensure that the 'D' in 'onDeck' is in uppercase. A lowercase 'D' will return a 404 status code.


curl -X GET http://{ip_address}:32400/library/sections/{id}/onDeck?X-Plex-Token={plex_token}
import requests
plex_url = http://{ip_address}:32400/library/sections/{id}/onDeck?X-Plex-Token={plex_token}
response = requests.get(plex_url)
$response = Invoke-RestMethod 'http://{ip_address}:32400/library/sections/{id}/onDeck?X-Plex-Token={plex_token}' -Method 'GET'
Write-Output $response