# GetLibraryMatchesRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [Optional[components.Accepts]](../../models/components/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `client_identifier` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional[str]* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional[str]* | :heavy_minus_sign: | The platform of the client | Roku |
| `platform_version` | *Optional[str]* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional[str]* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `device_vendor` | *Optional[str]* | :heavy_minus_sign: | The device vendor | Roku |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional[str]* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `type` | [Optional[components.MediaType]](../../models/components/mediatype.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
5 = artist
6 = album
7 = track
8 = photo_album
9 = photo
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
| 2 |
| `include_full_metadata` | [Optional[components.BoolInt]](../../models/components/boolint.md) | :heavy_minus_sign: | N/A | 1 |
| `include_ancestor_metadata` | [Optional[components.BoolInt]](../../models/components/boolint.md) | :heavy_minus_sign: | N/A | 1 |
| `include_alternate_metadata_sources` | [Optional[components.BoolInt]](../../models/components/boolint.md) | :heavy_minus_sign: | N/A | 1 |
| `guid` | *Optional[str]* | :heavy_minus_sign: | Used for movies, shows, artists, albums, and tracks. Allowed for various URI schemes, to be defined. | |
| `title` | *Optional[str]* | :heavy_minus_sign: | The title to filter by or assign | |
| `year` | *Optional[int]* | :heavy_minus_sign: | Used for movies shows, and albums. Optional. | |
| `path` | *Optional[str]* | :heavy_minus_sign: | Used for movies, episodes, and tracks. The full path to the media file, used for "cloud-scanning" an item. | |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | Used for episodes and tracks. The title of the show/artist. Required if `path` isn't passed. | |
| `grandparent_year` | *Optional[int]* | :heavy_minus_sign: | Used for episodes. The year of the show. | |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | Used for episodes and tracks. The season/album number. | |
| `index` | *Optional[int]* | :heavy_minus_sign: | Used for episodes and tracks. The episode/tracks number in the season/album. | |
| `originally_available_at` | *Optional[str]* | :heavy_minus_sign: | Used for episodes. In the format `YYYY-MM-DD`. | |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | Used for albums and tracks. The artist name for albums or the album name for tracks. | |