Files
plexcsharp/docs/Models/Requests/GetWatchlistRequest.md
2024-06-27 14:39:09 +00:00

16 lines
8.6 KiB
Markdown

# GetWatchlistRequest
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Filter` | [PathParamFilter](../../Models/Requests/PathParamFilter.md) | :heavy_check_mark: | Filter |
| `XPlexToken` | *string* | :heavy_check_mark: | User Token |
| `Sort` | *string* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> |
| `Libtype` | [Libtype](../../Models/Requests/Libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> |
| `Maxresults` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
| `IncludeCollections` | [IncludeCollections](../../Models/Requests/IncludeCollections.md) | :heavy_minus_sign: | include collections in the results<br/> |
| `IncludeExternalMedia` | [IncludeExternalMedia](../../Models/Requests/IncludeExternalMedia.md) | :heavy_minus_sign: | include external media in the results<br/> |
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |