Plex API Documentation home page
Plex API Documentation
Search...
Suggest an edit
Suggest an edit
Search...
Navigation
Library
Get On Deck
Documentation
Plex API Reference
Community
Server
GET
Get Server Capabilities
GET
Get Server Preferences
GET
Get Available Clients
GET
Get Devices
GET
Get Server Identity
GET
Get MyPlex Account
GET
Get a Resized Photo
GET
Get Media Providers
GET
Get Server List
Media
GET
Mark Media Played
GET
Mark Media Unplayed
POST
Update Media Play Progress
GET
Get Banner Image
GET
Get Thumb Image
Video
GET
Get the timeline for a media item
GET
Start Universal Transcode
Activities
GET
Get Server Activities
DEL
Cancel Server Activities
Butler
GET
Get Butler tasks
POST
Start all Butler tasks
DEL
Stop all Butler tasks
POST
Start a single Butler task
DEL
Stop a single Butler task
Plex
GET
Get Companions Data
GET
Get list of friends of the user logged in
GET
Get Geo Data
GET
Get Plex Home Data
GET
Get Server Resources
POST
Get a Pin
GET
Get Access Token by PinId
Hubs
GET
Get Global Hubs
GET
Get Recently Added
GET
Get library specific hubs
Search
GET
Perform a search
GET
Perform a voice search
GET
Get Search Results
Library
GET
Get Hash Value
GET
Get Recently Added
GET
Get All Libraries
GET
Get library details
DEL
Delete library section
GET
Get library items
GET
Refresh Metadata Of The Library
GET
Search library
GET
Get Metadata by RatingKey
GET
Get Items Children
GET
Get Top Watched Content
GET
Get On Deck
Watchlist
GET
Get User Watchlist
Log
GET
Logging a single line message.
POST
Logging a multi-line message
GET
Enabling Papertrail
Playlists
GET
Get All Playlists
POST
Create a Playlist
GET
Retrieve Playlist
PUT
Update a Playlist
DEL
Deletes a Playlist
GET
Retrieve Playlist Contents
PUT
Adding to a Playlist
DEL
Delete Playlist Contents
POST
Upload Playlist
Authentication
GET
Get a Transient Token
GET
Get Source Connection Information
GET
Get Token Details
POST
Get User Sign In Data
Statistics
GET
Get Media Statistics
GET
Get Resources Statistics
GET
Get Bandwidth Statistics
Sessions
GET
Get Active Sessions
GET
Get Session History
GET
Get Transcode Sessions
DEL
Stop a Transcode Session
Updater
GET
Querying status of updates
PUT
Checking for updates
PUT
Apply Updates
Library
Get On Deck
This endpoint will return the on deck content.
GET
/
library
/
onDeck
Try it
Authorizations
​
X-Plex-Token
string
header
required
Plex Authentication Token
Response
200 - application/json
​
MediaContainer
object
Show child attributes
​
MediaContainer.
allowSync
boolean
​
MediaContainer.
identifier
string
​
MediaContainer.
mediaTagPrefix
string
​
MediaContainer.
mediaTagVersion
number
​
MediaContainer.
Metadata
object[]
Show child attributes
​
MediaContainer.Metadata.
addedAt
number
​
MediaContainer.Metadata.
allowSync
boolean
​
MediaContainer.Metadata.
art
string
​
MediaContainer.Metadata.
contentRating
string
​
MediaContainer.Metadata.
duration
number
​
MediaContainer.Metadata.
grandparentArt
string
​
MediaContainer.Metadata.
grandparentGuid
string
​
MediaContainer.Metadata.
grandparentKey
string
​
MediaContainer.Metadata.
grandparentRatingKey
number
​
MediaContainer.Metadata.
grandparentTheme
string
​
MediaContainer.Metadata.
grandparentThumb
string
​
MediaContainer.Metadata.
grandparentTitle
string
​
MediaContainer.Metadata.
guid
string
​
MediaContainer.Metadata.
Guid
object[]
Show child attributes
​
MediaContainer.Metadata.Guid.
id
string
​
MediaContainer.Metadata.
index
number
​
MediaContainer.Metadata.
key
string
​
MediaContainer.Metadata.
lastViewedAt
number
​
MediaContainer.Metadata.
librarySectionID
number
​
MediaContainer.Metadata.
librarySectionKey
string
​
MediaContainer.Metadata.
librarySectionTitle
string
​
MediaContainer.Metadata.
librarySectionUUID
string
​
MediaContainer.Metadata.
Media
object[]
Show child attributes
​
MediaContainer.Metadata.Media.
aspectRatio
number
​
MediaContainer.Metadata.Media.
audioChannels
number
​
MediaContainer.Metadata.Media.
audioCodec
string
​
MediaContainer.Metadata.Media.
audioProfile
string
​
MediaContainer.Metadata.Media.
bitrate
number
​
MediaContainer.Metadata.Media.
container
string
​
MediaContainer.Metadata.Media.
duration
number
​
MediaContainer.Metadata.Media.
height
number
​
MediaContainer.Metadata.Media.
id
number
​
MediaContainer.Metadata.Media.
Part
object[]
Show child attributes
​
MediaContainer.Metadata.Media.Part.
audioProfile
string
​
MediaContainer.Metadata.Media.Part.
container
string
​
MediaContainer.Metadata.Media.Part.
duration
number
​
MediaContainer.Metadata.Media.Part.
file
string
​
MediaContainer.Metadata.Media.Part.
id
number
​
MediaContainer.Metadata.Media.Part.
key
string
​
MediaContainer.Metadata.Media.Part.
size
number
​
MediaContainer.Metadata.Media.Part.
Stream
object[]
Show child attributes
​
MediaContainer.Metadata.Media.Part.
videoProfile
string
​
MediaContainer.Metadata.Media.
videoCodec
string
​
MediaContainer.Metadata.Media.
videoFrameRate
string
​
MediaContainer.Metadata.Media.
videoProfile
string
​
MediaContainer.Metadata.Media.
videoResolution
string
​
MediaContainer.Metadata.Media.
width
number
​
MediaContainer.Metadata.
originallyAvailableAt
string
​
MediaContainer.Metadata.
parentGuid
string
​
MediaContainer.Metadata.
parentIndex
number
​
MediaContainer.Metadata.
parentKey
string
​
MediaContainer.Metadata.
parentRatingKey
number
​
MediaContainer.Metadata.
parentThumb
string
​
MediaContainer.Metadata.
parentTitle
string
​
MediaContainer.Metadata.
ratingKey
number
​
MediaContainer.Metadata.
summary
string
​
MediaContainer.Metadata.
thumb
string
​
MediaContainer.Metadata.
title
string
​
MediaContainer.Metadata.
type
string
​
MediaContainer.Metadata.
updatedAt
number
​
MediaContainer.Metadata.
year
number
​
MediaContainer.
mixedParents
boolean
​
MediaContainer.
size
number
Get Top Watched Content
Get User Watchlist