anything that you see in curly braces {} is a required item.
if the required item is simply {id} then the id for that API grouping is required. in the example below the id that is needed is the "item id"
if there is a grouping id and also another id that is needed then they will be identified as such
Code: Select all
Shows
get Shows/{series_id}/Seasons
[UserId, Fields, IsMissing, IsVirtualUnaired, IsSpecialSeason]
get Shows/{series_id}/Episodes
[UserId, Fields, Limit, StartIndex, Season, SeasonId, StartItemId, IsMissing, IsVirtualUnaired]
get Shows/Upcoming
[UserId, Fields, ImageTypeLimit, EnableImageTypes, EnableImages, StartIndex, Limit]
MetaData
get Persons
get Genres
get Studios
get Artists
get Artists/AlbumArtists
Users
get Users
[IsHidden, IsDisabled]
get Users/Public
get Users/{id}
get Users/{id}/Views
get Users/{id}/Items/Root
get Users/{user_id}/Items/{item_id}
get Users/{user_id}/Items/{item_id}/SpecialFeatures
get Users/{user_id}/Items/{item_id}/LocalTrailers
get Users/{user_id}/Items/{item_id}/Intros
Localization
get Localization/Countries
get Localization/Cultures
get Localization/ParentalRatings
Plugins
get Plugins
System
post System/Restart
get System/Info
get System/Info/Public
get System/Configuration
get System/Configuration/devices
get System/Endpoint
ScheduledTasks
get ScheduledTasks
get ScheduledTasks/{id}
DisplayPreferences
get DisplayPreferences/{id}
Notifications
get Notifications/{user_id}
[ItemIds, StartIndex, Limit]
post Notifications/{user_id}/Read
[Ids]
post Notifications/{user_id}/Unread
[Ids]
get Notifications/{user_id}/Summary
Search
get Search/Hints
[MediaTypes, IsSports, IsSeries, IsNews, IsMovie, IsKids, IncludeItemTypes,
ExcludeItemTypes, IncludeStudios, IncludePeople, IncludeMedia, IncludeGenres,
IncludeArtists, Limit, StartIndex, ParentId, UserId, SearchTerm]
Games
get Games/PlayerIndex
[UserId]
get Games/SystemSummaries
Movies
get Movies/Recommendations
[Fields, CategoryLimit, ItemLimit, ParentId, UserId]
LiveStream
post OpenLiveStream
Items
Optional parameters available to all of the Items API
[AiredDuringSeason, IsVirtualUnaired, IsUnaired, IsMissing, ExcludeLocationTypes, LocationTypes,
AlbumArtistStartsWithOrGreater, NameStartsWithOrGreater, MaxPlayers, MinPlayers,
MinCommunityRating, MinCriticRating, SearchTerm, HasParentalRating, IsHD, ParentIndexNumber,
Years, PersonTypes, PersonIds, IsInBoxSet, IsPlayed, ArtistIds, IncludeItemTypes, ExcludeItemTypes,
StudioIds, Ids, Genres, MediaTypes, CollapseBoxSetItems, ImageTypeLimit, EnableImageTypes,
EnableImages, MinIndexNumber, Recursive, MaxOfficialRating, MinOfficialRating, AirDays, VideoTypes,
Is3D, ImageTypes, Filters, Fields, SeriesStatuses, SortOrder, EnableTotalRecordCount, SortBy, Limit,
StartIndex, ParentId, InheritFromParent, UserId]
get Items
get Items/Counts
get Items/YearIndex
get Items/{id}/PlaybackInfo
get Items/{id}/CriticReviews
get Items/{id}/ThemeVideos
get Items/{id}/ThemeSong
get Items/{id}/ThemeMedia
Sessions
get Sessions
[ControllableByUserId, DeviceId]
post Sessions/Capabilities/Full
post Sessions/{id}/Playing/{Stopped, }
post Sessions/Playing/Progress
post Sessions/Logout
post Sessions/{id}/Playing
[ItemIds, StartPositionTicks, PlayCommand]
post Sessions/{id}/Command
[SetVolume
[Volume]
SetSubtitleStreamIndex
)[Index]
SetAudioStreamIndex
[Index]
SendString
[String]
DisplayMessage
[Header, Text, Timeout]
DisplayContent
[ItemType, ItemId, ItemName]
MoveUp
MoveDown
MoveLeft
MoveRight
PageUp
PageDown
PreviousLetter
NextLetter
ToggleOsd
ToggleContextMenu
Select
Back
SendKey
GoHome
GoToSettings
VolumeUp
VolumeDown
Mute
Unmute
ToggleMute
GoToSearch
SetRepeatMode
ChannelUp
ChannelDown
PlayMediaSource]
Videos
get Videos/{id}/AdditionalParts
[UserId]
Channels
get Channels/{id}/Features
get Channels/{id}/Items
[SortOrder, SortBy, Filters, Fields, FolderId, Limit, StartIndex, UserId]
get Channels
[IsFavorite, Limit, StartIndex, SupportsLatestItems, UserId]
LiveTv
get LiveTv/Info
get LiveTv/GuideInfo
get LiveTv/Recordings
[UserId, UserId, GroupId, Id, SeriesTimerId, IsInProgress, StartIndex, Limit, EnableTotalRecordCount]
get LiveTv/Recordings/{id}
[userId]
get LiveTv/Recordings/Groups
[UserId]
get LiveTv/Recordings/Groups/{id}
[userId]
get LiveTv/Channels
[UserId, StartIndex, Limit, IsFavorite, IsLiked, IsDisliked, EnableFavoriteSorting, ChannelType]
get LiveTv/Channels/{id} [userId]
get LiveTv/Programs
[ChannelIds, EnableTotalRecordCount, UserId, MinStartDate, MinEndDate, MaxStartDate, MaxEndDate]
get LiveTv/Programs/{id}
[userId]
get LiveTv/Programs/Recommended
[EnableTotalRecordCount, IsAiring, HasAired, Limit, UserId]