GET
/
library
/
sections
/
{sectionKey}
/
all
declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();

$request = new Operations\GetAllMediaLibraryRequest(
    sectionKey: 9518,
    type: Operations\GetAllMediaLibraryQueryParamType::TvShow,
);

$response = $sdk->library->getAllMediaLibrary(
    request: $request
);

if ($response->object !== null) {
    // handle response
}
{
  "MediaContainer": {
    "size": 50,
    "totalSize": 50,
    "offset": 0,
    "allowSync": false,
    "art": "/:/resources/show-fanart.jpg",
    "content": "secondary",
    "identifier": "com.plexapp.plugins.library",
    "librarySectionID": 2,
    "librarySectionTitle": "TV Series",
    "librarySectionUUID": "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
    "mediaTagPrefix": "/system/bundle/media/flags/",
    "mediaTagVersion": 1734362201,
    "thumb": "/:/resources/show.png",
    "nocache": true,
    "title1": "TV Series",
    "title2": "By Starring Actor",
    "viewGroup": "secondary",
    "Meta": {
      "Type": [
        {
          "key": "/library/sections/2/all?type=2",
          "type": "filter",
          "subtype": "clip",
          "title": "TV Shows",
          "active": false,
          "Filter": [
            {
              "filter": "genre",
              "filterType": "string",
              "key": "/library/sections/2/genre?type=2",
              "title": "Genre",
              "type": "filter",
              "advanced": true
            }
          ],
          "Sort": [
            {
              "default": "asc",
              "active": false,
              "activeDirection": "asc",
              "defaultDirection": "asc",
              "descKey": "titleSort:desc",
              "firstCharacterKey": "/library/sections/2/firstCharacter",
              "key": "titleSort",
              "title": "Title"
            }
          ],
          "Field": [
            {
              "key": "show.title",
              "title": "Show Title",
              "type": "string",
              "subType": "rating"
            }
          ]
        }
      ],
      "FieldType": [
        {
          "type": "tag",
          "Operator": [
            {
              "key": "=",
              "title": "is"
            }
          ]
        }
      ]
    },
    "Metadata": [
      {
        "ratingKey": "58683",
        "key": "/library/metadata/58683",
        "guid": "plex://movie/5d7768ba96b655001fdc0408",
        "slug": "4-for-texas",
        "studio": "20th Century Studios",
        "type": "movie",
        "title": "Avatar: The Way of Water",
        "titleSort": "Whale",
        "contentRating": "PG-13",
        "summary": "Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\nOnce a familiar threat returns to finish what was previously started, Jake must\nwork with Neytiri and the army of the Na'vi race to protect their home.\n",
        "rating": 7.6,
        "audienceRating": 9.2,
        "year": 2022,
        "tagline": "Return to Pandora.",
        "thumb": "/library/metadata/58683/thumb/1703239236",
        "art": "/library/metadata/58683/art/1703239236",
        "theme": "/library/metadata/1/theme/1705636920",
        "index": 1,
        "leafCount": 14,
        "viewedLeafCount": 0,
        "childCount": 1,
        "seasonCount": 2022,
        "duration": 11558112,
        "originallyAvailableAt": "2022-12-14",
        "addedAt": 1556281940,
        "updatedAt": 1556281940,
        "audienceRatingImage": "rottentomatoes://image.rating.upright",
        "chapterSource": "media",
        "primaryExtraKey": "/library/metadata/58684",
        "originalTitle": "映画 ブラッククローバー 魔法帝の剣",
        "parentRatingKey": "66",
        "grandparentRatingKey": "66",
        "parentGuid": "plex://show/5d9c081b170e24001f2a7be4",
        "grandparentGuid": "plex://show/5d9c081b170e24001f2a7be4",
        "grandparentSlug": "alice-in-borderland-2020",
        "grandparentKey": "/library/metadata/66",
        "parentKey": "/library/metadata/66",
        "grandparentTitle": "Caprica",
        "grandparentThumb": "/library/metadata/66/thumb/1705716261",
        "grandparentTheme": "/library/metadata/66/theme/1705716261",
        "grandparentArt": "/library/metadata/66/art/1705716261",
        "parentTitle": "Caprica",
        "parentIndex": 1,
        "parentThumb": "/library/metadata/66/thumb/1705716261",
        "ratingImage": "rottentomatoes://image.rating.ripe",
        "viewCount": 1,
        "viewOffset": 5222500,
        "skipCount": 1,
        "subtype": "clip",
        "lastRatedAt": 1721813113,
        "createdAtAccuracy": "epoch,local",
        "createdAtTZOffset": "0",
        "lastViewedAt": 1682752242,
        "userRating": 10,
        "Image": [
          {
            "alt": "Episode 1",
            "type": "background",
            "url": "/library/metadata/45521/thumb/1644710589"
          }
        ],
        "UltraBlurColors": {
          "topLeft": "11333b",
          "topRight": "0a232d",
          "bottomRight": 73958,
          "bottomLeft": "1f5066"
        },
        "Media": [
          {
            "id": 387322,
            "duration": 9610350,
            "bitrate": 25512,
            "width": 3840,
            "height": 1602,
            "aspectRatio": 2.35,
            "audioChannels": 6,
            "displayOffset": 50,
            "audioCodec": "eac3",
            "videoCodec": "hevc",
            "videoResolution": "4k",
            "container": "mkv",
            "videoFrameRate": "24p",
            "videoProfile": "main 10",
            "hasVoiceActivity": false,
            "audioProfile": "dts",
            "optimizedForStreaming": 0,
            "has64bitOffsets": false,
            "Part": [
              {
                "accessible": true,
                "exists": true,
                "id": 418385,
                "key": "/library/parts/418385/1735864239/file.mkv",
                "indexes": "sd",
                "duration": 9610350,
                "file": "/mnt/Movies_1/W/Wicked (2024).mkv",
                "size": 30649952104,
                "packetLength": 188,
                "container": "mkv",
                "videoProfile": "main 10",
                "audioProfile": "dts",
                "has64bitOffsets": false,
                "optimizedForStreaming": 0,
                "hasThumbnail": "1",
                "Stream": [
                  {
                    "id": 1002625,
                    "streamType": 1,
                    "default": true,
                    "codec": "hevc",
                    "index": 0,
                    "bitrate": 24743,
                    "language": "English",
                    "languageTag": "en",
                    "languageCode": "eng",
                    "headerCompression": true,
                    "DOVIBLCompatID": 1,
                    "DOVIBLPresent": true,
                    "DOVIELPresent": false,
                    "DOVILevel": 6,
                    "DOVIPresent": true,
                    "DOVIProfile": 8,
                    "DOVIRPUPresent": true,
                    "DOVIVersion": "1.0",
                    "bitDepth": 10,
                    "chromaLocation": "topleft",
                    "chromaSubsampling": "4:2:0",
                    "codedHeight": 1608,
                    "codedWidth": 3840,
                    "colorPrimaries": "bt2020",
                    "colorRange": "tv",
                    "colorSpace": "bt2020nc",
                    "colorTrc": "smpte2084",
                    "frameRate": 23.976,
                    "height": 1602,
                    "level": 150,
                    "original": true,
                    "hasScalingMatrix": false,
                    "profile": "main 10",
                    "scanType": "progressive",
                    "refFrames": 1,
                    "width": 3840,
                    "displayTitle": "4K DoVi/HDR10 (HEVC Main 10)",
                    "extendedDisplayTitle": "4K DoVi/HDR10 (HEVC Main 10)",
                    "selected": true,
                    "forced": true,
                    "channels": 6,
                    "audioChannelLayout": "5.1(side)",
                    "samplingRate": 48000,
                    "canAutoSync": false,
                    "hearingImpaired": true,
                    "dub": true,
                    "title": "SDH"
                  }
                ]
              }
            ]
          }
        ],
        "Genre": [
          {
            "tag": "United States of America"
          }
        ],
        "Country": [
          {
            "tag": "United States of America"
          }
        ],
        "Director": [
          {
            "tag": "Danny Boyle"
          }
        ],
        "Writer": [
          {
            "tag": "Danny Boyle"
          }
        ],
        "Role": [
          {
            "tag": "Danny Boyle"
          }
        ],
        "Guid": [
          {
            "id": "tvdb://2337"
          }
        ],
        "Collection": [
          {
            "tag": "My Awesome Collection"
          }
        ]
      }
    ]
  }
}

Authorizations

​
X-Plex-Token
string
header
required

Plex Authentication Token

Headers

​
Accept
enum<string>
Available options:
application/json,
application/xml
Example:

"application/json"

Path Parameters

​
sectionKey
integer
required

The unique key of the Plex library. Note: This is unique in the context of the Plex server.

Example:

9518

Query Parameters

​
type
enum<integer>
required

The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries

Available options:
1,
2,
3,
4,
8,
9,
10
Example:

2

​
includeMeta
enum<integer>
default:0

Adds the Meta object to the response

Available options:
0,
1
Example:

1

​
includeGuids
enum<integer>
default:0

Adds the Guid object to the response

Available options:
0,
1
Example:

1

​
includeAdvanced
enum<integer>
default:0
Available options:
0,
1
Example:

1

​
includeCollections
enum<integer>
default:0
Available options:
0,
1
Example:

1

​
includeExternalMedia
enum<integer>
default:0
Available options:
0,
1
Example:

1

​
X-Plex-Container-Start
integer
default:0

The index of the first item to return. If not specified, the first item will be returned. If the number of items exceeds the limit, the response will be paginated. By default this is 0

Example:

0

​
X-Plex-Container-Size
integer
default:50

The number of items to return. If not specified, all items will be returned. If the number of items exceeds the limit, the response will be paginated. By default this is 50

Example:

50

Response

200
application/json
Successful response containing media container data.
​
MediaContainer
object
Get library itemsRefresh Metadata Of The Library