--- id: get-on-deck sidebar_label: Get On Deck hide_title: true hide_table_of_contents: true api: {"tags":["Library"],"description":"This endpoint will return the on deck content.\n","operationId":"getOnDeck","responses":{"200":{"description":"The on Deck content","content":{"application/json":{"schema":{"type":"object","properties":{"MediaContainer":{"type":"object","properties":{"size":{"type":"number","example":16},"allowSync":{"type":"boolean"},"identifier":{"type":"string","example":"com.plexapp.plugins.library"},"mediaTagPrefix":{"type":"string","example":"/system/bundle/media/flags/"},"mediaTagVersion":{"type":"number","example":1680021154},"mixedParents":{"type":"boolean"},"Metadata":{"type":"array","items":{"type":"object","properties":{"allowSync":{"type":"boolean"},"librarySectionID":{"type":"number","example":2},"librarySectionTitle":{"type":"string","example":"TV Shows"},"librarySectionUUID":{"type":"string","example":"4bb2521c-8ba9-459b-aaee-8ab8bc35eabd"},"ratingKey":{"type":"string","example":49564},"key":{"type":"string","example":"/library/metadata/49564"},"parentRatingKey":{"type":"string","example":49557},"grandparentRatingKey":{"type":"string","example":49556},"guid":{"type":"string","example":"plex://episode/5ea7d7402e7ab10042e74d4f"},"parentGuid":{"type":"string","example":"plex://season/602e754d67f4c8002ce54b3d"},"grandparentGuid":{"type":"string","example":"plex://show/5d9c090e705e7a001e6e94d8"},"type":{"type":"string","example":"episode"},"title":{"type":"string","example":"Circus"},"grandparentKey":{"type":"string","example":"/library/metadata/49556"},"parentKey":{"type":"string","example":"/library/metadata/49557"},"librarySectionKey":{"type":"string","example":"/library/sections/2"},"grandparentTitle":{"type":"string","example":"Bluey (2018)"},"parentTitle":{"type":"string","example":"Season 2"},"contentRating":{"type":"string","example":"TV-Y"},"summary":{"type":"string","example":"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy."},"index":{"type":"number","example":33},"parentIndex":{"type":"number","example":2},"lastViewedAt":{"type":"number","example":1681908352},"year":{"type":"number","example":2018},"thumb":{"type":"string","example":"/library/metadata/49564/thumb/1654258204"},"art":{"type":"string","example":"/library/metadata/49556/art/1680939546"},"parentThumb":{"type":"string","example":"/library/metadata/49557/thumb/1654258204"},"grandparentThumb":{"type":"string","example":"/library/metadata/49556/thumb/1680939546"},"grandparentArt":{"type":"string","example":"/library/metadata/49556/art/1680939546"},"grandparentTheme":{"type":"string","example":"/library/metadata/49556/theme/1680939546"},"duration":{"type":"number","example":420080},"originallyAvailableAt":{"type":"string","format":"date","example":"2020-10-31T00:00:00.000Z"},"addedAt":{"type":"number","example":1654258196},"updatedAt":{"type":"number","example":1654258204},"Media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":80994},"duration":{"type":"number","example":420080},"bitrate":{"type":"number","example":1046},"width":{"type":"number","example":1920},"height":{"type":"number","example":1080},"aspectRatio":{"type":"number","example":1.78},"audioChannels":{"type":"number","example":2},"audioCodec":{"type":"string","example":"aac"},"videoCodec":{"type":"string","example":"hevc"},"videoResolution":{"type":"string","example":1080},"container":{"type":"string","example":"mkv"},"videoFrameRate":{"type":"string","example":"PAL"},"audioProfile":{"type":"string","example":"lc"},"videoProfile":{"type":"string","example":"main"},"Part":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":80994},"key":{"type":"string","example":"/library/parts/80994/1655007810/file.mkv"},"duration":{"type":"number","example":420080},"file":{"type":"string","example":"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv"},"size":{"type":"number","example":55148931},"audioProfile":{"type":"string","example":"lc"},"container":{"type":"string","example":"mkv"},"videoProfile":{"type":"string","example":"main"},"Stream":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":211234},"streamType":{"type":"number","example":1},"default":{"type":"boolean"},"codec":{"type":"string","example":"hevc"},"index":{"type":"number","example":0},"bitrate":{"type":"number","example":918},"language":{"type":"string","example":"English"},"languageTag":{"type":"string","example":"en"},"languageCode":{"type":"string","example":"eng"},"bitDepth":{"type":"number","example":8},"chromaLocation":{"type":"string","example":"left"},"chromaSubsampling":{"type":"string","example":14520},"codedHeight":{"type":"number","example":1080},"codedWidth":{"type":"number","example":1920},"colorRange":{"type":"string","example":"tv"},"frameRate":{"type":"number","example":25},"height":{"type":"number","example":1080},"level":{"type":"number","example":120},"profile":{"type":"string","example":"main"},"refFrames":{"type":"number","example":1},"width":{"type":"number","example":1920},"displayTitle":{"type":"string","example":"1080p (HEVC Main)"},"extendedDisplayTitle":{"type":"string","example":"1080p (HEVC Main)"}}}}}}}}}},"Guid":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"imdb://tt13303712"}}}}}}}}}}}}}},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number","example":1001},"message":{"type":"string","example":"User could not be authenticated"},"status":{"type":"number","example":401}}}}}}}}}},"method":"get","path":"/library/onDeck","servers":[{"url":"http://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}},{"url":"https://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"Token":[],"ClientIdentifier":[],"Device":[],"DeviceName":[],"Platform":[],"PlatformVersion":[],"Product":[],"Version":[]}],"securitySchemes":{"Token":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Token"},"ClientIdentifier":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Client-Identifier"},"DeviceName":{"description":"Primary name for the device eg. `Plex Web (Chrome)`","type":"apiKey","in":"header","name":"X-Plex-Device-Name"},"Device":{"description":"The type of device your application is running on\nDevice name and or model number, eg `iPhone3,2`, `Motorola XOOMâ„¢`, `LG5200TV`\n","type":"apiKey","in":"header","name":"X-Plex-Device"},"PlatformVersion":{"description":"Operating system version\neg `4.3.1`, `10.6.7`, `3.2`\n","type":"apiKey","in":"header","name":"X-Plex-Platform-Version"},"Platform":{"description":"Platform name \neg: `Web`, `iOS`, `MacOSX`, `Android`, `LG`\n","type":"apiKey","in":"header","name":"X-Plex-Platform"},"Product":{"description":"Plex application name \neg: `Laika`, `Plex Media Server`, `Media Link`\n","type":"apiKey","in":"header","name":"X-Plex-Product"},"Version":{"description":"Plex application version number","type":"apiKey","in":"header","name":"X-Plex-Version"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.3","contact":{"name":"Luke Hagar","url":"https://www.LukeHagar.com","email":"Lukeslakemail@gmail.com"},"license":{"name":"MIT","identifier":"MIT","url":"https://opensource.org/licenses/MIT"}},"postman":{"name":"Get On Deck","description":{"content":"This endpoint will return the on deck content.\n","type":"text/plain"},"url":{"path":["library","onDeck"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/plex-media-server/plex-api --- import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem";

Get On Deck

This endpoint will return the on deck content.
The on Deck content
Schema
    MediaContainer object
    Metadata object[]
  • Array [
  • Media object[]
  • Array [
  • Part object[]
  • Array [
  • Stream object[]
  • Array [
  • ]
  • ]
  • ]
  • Guid object[]
  • Array [
  • ]
  • ]
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
Schema
    errors object[]
  • Array [
  • ]