list_library_matches
Find Plex library items matching specified metadata like GUID, title, year, path, or season/episode numbers. Supports optional full metadata inclusion for detailed results.
Instructions
Get library matches.
GET /library/matches
Args:
include_full_metadata: Include full metadata in the response
include_ancestor_metadata: Include ancestor metadata in the response
include_alternate_metadata_sources: Include alternate metadata sources in the response
guid: Used for movies, shows, artists, albums, and tracks. Allowed for various URI schemes, to be defined.
year: Used for movies shows, and albums. Optional.
path: Used for movies, episodes, and tracks. The full path to the media file, used for "cloud-scanning" an item.
grandparent_title: Used for episodes and tracks. The title of the show/artist. Required if path isn't passed.
grandparent_year: Used for episodes. The year of the show.
parent_index: Used for episodes and tracks. The season/album number.
index: Used for episodes and tracks. The episode/tracks number in the season/album.
originally_available_at: Used for episodes. In the format YYYY-MM-DD.
parent_title: Used for albums and tracks. The artist name for albums or the album name for tracks.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| guid | No | ||
| path | No | ||
| year | No | ||
| index | No | ||
| parent_index | No | ||
| parent_title | No | ||
| grandparent_year | No | ||
| grandparent_title | No | ||
| include_full_metadata | No | ||
| originally_available_at | No | ||
| include_ancestor_metadata | No | ||
| include_alternate_metadata_sources | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |