Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 10.9 KB

getwatchlistrequest.md

File metadata and controls

26 lines (21 loc) · 10.9 KB

GetWatchListRequest

Example Usage

import { Filter, GetWatchListRequest } from "@lukehagar/plexjs/sdk/models/operations";

let value: GetWatchListRequest = {
  filter: Filter.Available,
  xPlexToken: "CV5xoxjTpFKUzBTShsaf",
};

Fields

Field Type Required Description Example
filter operations.Filter ✔️ Filter
sort string ➖ In the format "field:dir". Available fields are "watchlistedAt" (Added At),
"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).
"dir" can be "asc" or "desc"
libtype operations.Libtype ➖ The type of library to filter. Can be "movie" or "show", or all if not present.
maxresults number ➖ 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.
includeCollections operations.IncludeCollections ➖ include collections in the results
includeExternalMedia operations.IncludeExternalMedia ➖ include external media in the results
xPlexContainerStart number ➖ 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
 0
xPlexContainerSize number ➖ 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
 50
xPlexToken string ✔️ An authentication token, obtained from plex.tv CV5xoxjTpFKUzBTShsaf