Home
Generated home operations.
GET/v1/homeRead this viewer's composed Home rows and destinationsread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_home
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | ""≥ 1 |
Responses
200Successapplication/json
{
"generatedAt": "2026-10-18T19:30:00Z",
"layout": {
"hiddenRowIds": [
"string"
],
"revision": 0,
"rowOrder": [
"string"
]
},
"privacyFence": "string",
"revision": {
"catalog": 0,
"viewer": 0
},
"rows": [
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"children": [
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"collection": {},
"critical": true,
"cursorCapable": true,
"deferred": false,
"displayTargets": [],
"endpoint": "string",
"entries": [],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {},
"nextCursor": "eyJvIjoyMH0",
"period": {},
"platforms": [],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [],
"revision": {},
"seeAll": {},
"start": 0,
"subtitleText": {},
"title": "Fargo",
"titleText": {},
"total": 0,
"viewerFence": "string",
"why": {},
"whyTitles": []
}
],
"collection": {
"actions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"backdropUrl": "https://example.com/…",
"collection": {
"id": "id_8h2k4q",
"itemCount": 0,
"libraryId": "id_8h2k4q",
"name": "Fargo",
"origin": "string",
"revision": 0
},
"firstYear": 0,
"lastTitle": "Fargo",
"mediaKind": "string",
"members": [
{}
]
},
"critical": true,
"cursorCapable": true,
"deferred": true,
"displayTargets": [
{
"entryId": "id_8h2k4q",
"membershipId": "id_8h2k4q"
}
],
"endpoint": "string",
"entries": [
{
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {},
"albumCount": 0,
"albumType": "string",
"artist": {},
"artistType": "string",
"artworkPaths": [],
"audioFacts": {},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [],
"bookProgress": {},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [],
"hidden": true,
"homeActions": {},
"homeTitleContext": {},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {},
"libraryId": "id_8h2k4q",
"media": {},
"missing": true,
"narrators": [],
"navigation": {},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {},
"rating": 0,
"readingMark": {},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [],
"show": {},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {
"channels": [
{}
],
"expiresAt": "2026-10-18T19:30:00Z",
"group": "string",
"groups": [
{}
],
"observedAt": "2026-10-18T19:30:00Z",
"revision": "r12",
"sort": "favorites"
},
"nextCursor": "eyJvIjoyMH0",
"period": {
"days": 0,
"end": "string",
"metric": "string",
"start": "string",
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"platforms": [
"string"
],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {
"kind": "string",
"libraryId": "id_8h2k4q",
"source": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [
{
"entryId": "id_8h2k4q",
"target": {}
}
],
"revision": {
"catalog": 0,
"viewer": 0
},
"seeAll": {
"group": "string",
"sourceId": "id_8h2k4q",
"type": "guide"
},
"start": 0,
"subtitleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"title": "Fargo",
"titleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"total": 0,
"viewerFence": "string",
"why": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"whyTitles": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
]
}
],
"serverId": "id_8h2k4q",
"spotlight": [
{
"entry": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"hidden": true,
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"homeTitleContext": {
"genres": [],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"media": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {},
"albumCount": 0,
"albumType": "string",
"artist": {},
"artistType": "string",
"artworkPaths": [],
"audioFacts": {},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [],
"bookProgress": {},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [],
"homeActions": {},
"homeTitleContext": {},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {},
"libraryId": "id_8h2k4q",
"missing": true,
"narrators": [],
"navigation": {},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {},
"rating": 0,
"readingMark": {},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [],
"show": {},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
},
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
},
"reason": {
"kind": "string",
"libraryId": "id_8h2k4q",
"source": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"resumeTarget": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"hidden": true,
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"homeTitleContext": {
"genres": [],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"media": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {},
"albumCount": 0,
"albumType": "string",
"artist": {},
"artistType": "string",
"artworkPaths": [],
"audioFacts": {},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [],
"bookProgress": {},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [],
"homeActions": {},
"homeTitleContext": {},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {},
"libraryId": "id_8h2k4q",
"missing": true,
"narrators": [],
"navigation": {},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {},
"rating": 0,
"readingMark": {},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [],
"show": {},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
},
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
}
],
"viewerFence": "string"
}- generatedAtstringrequired
layoutobjectrequired
- hiddenRowIdsarray of stringrequired
- revisionintegerrequired
- rowOrderarray of stringrequired
- privacyFencestring
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
rowsarray of objectrequired0–64 items
- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
childrenarray of object0–5 items
- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
collectionobject
actionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
- chapterobject
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
- selectionobjectrequired
- stateobjectrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
- browseobject
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
- sortarray of objectrequired0–1 items
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredbooleanone of false
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
- sortarray of objectrequired0–1 items
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
- episodeobject
- episodeIdstring
- flagsobjectrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
- ratingobject
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
- chapterobject
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
- selectionobjectrequired
- stateobjectrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
- browseobject
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
- sortarray of objectrequired0–1 items
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
collectionobject
actionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
- sortarray of objectrequired0–1 items
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredboolean
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
episodeobject
- displaystring
- numberinteger
- seasoninteger
- episodeIdstring
flagsobjectrequired
- livebooleanrequired
- newbooleanrequired
- premierebooleanrequired
- repeatbooleanrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
ratingobject
- systemstringrequired
- valuestringrequired
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
- sortarray of objectrequired0–1 items
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
- serverIdstringrequired
spotlightarray of objectrequired0–5 items
entryobjectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
reasonobjectrequired
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
resumeTargetobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- viewerFencestringrequired
defaultRequest refused or unavailableapplication/json
{
"error": {
"code": "string",
"message": "string"
}
}errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestinvalid_cursorstale_continuationunauthorizednot_permittednot_foundrate_limitedinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/home" \
-H "Authorization: Bearer $PORTICO_API_KEY"POST/v1/home/destination-pickerSearch one authorized playlist or collection destination windowread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
post_home_destination_picker- Max body
- 64 KiB
Request body application/json · required
{
"cursor": "eyJvIjoyMH0",
"itemIds": [
"string"
],
"kind": "string",
"limit": 0,
"query": "string"
}- cursorstring
- itemIdsarray of string
- kindstringrequired
- limitintegerrequired
- querystringrequired
Responses
200Successapplication/json
{
"kind": "string",
"nextCursor": "eyJvIjoyMH0",
"query": "string",
"revision": {
"catalog": 0,
"viewer": 0
},
"rows": [
{
"actions": [
"string"
],
"alreadyIn": 0,
"artwork": [
{
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {},
"albumCount": 0,
"albumType": "string",
"artist": {},
"artistType": "string",
"artworkPaths": [],
"audioFacts": {},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [],
"bookProgress": {},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [],
"hidden": true,
"homeActions": {},
"homeTitleContext": {},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {},
"libraryId": "id_8h2k4q",
"media": {},
"missing": true,
"narrators": [],
"navigation": {},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {},
"rating": 0,
"readingMark": {},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [],
"show": {},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
],
"canAdd": true,
"count": 0,
"id": "id_8h2k4q",
"name": "Fargo",
"revision": 0
}
],
"serverId": "id_8h2k4q",
"viewerFence": "string"
}- kindstringrequired
- nextCursorstringrequired
- querystringrequired
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
rowsarray of objectrequired
- actionsarray of stringrequired
- alreadyIninteger
artworkarray of objectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- canAddbooleanrequired
- countintegerrequired
- idstringrequired
- namestringrequired
- revisionintegerrequired
- serverIdstringrequired
- viewerFencestringrequired
defaultRequest refused or unavailableapplication/json
{
"error": {
"code": "string",
"message": "string"
}
}errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestinvalid_cursorunauthorizednot_foundrevision_mismatchinternaltimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/home/destination-picker" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"cursor":"eyJvIjoyMH0","itemIds":["string"],"kind":"string","limit":0,"query":"string"}'POST/v1/home/destination-receiptRead distinct durable membership outcomes for one authorized destination job setread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
post_home_destination_receipt- Max body
- 64 KiB
Request body application/json · required
{
"cursor": "eyJvIjoyMH0",
"destinationId": "id_8h2k4q",
"jobIds": [
"string"
],
"kind": "string"
}- cursorstring
- destinationIdstringrequired
- jobIdsarray of stringrequired
- kindstringrequired
Responses
200Successapplication/json
{
"added": 0,
"alreadyPresent": 0,
"complete": true,
"destinationId": "id_8h2k4q",
"failed": 0,
"failureEntries": [
{
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{
"bitDepth": 17,
"codec": "string",
"sampleRate": 1,
"variant": "lossless"
}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {
"endMs": 1800000,
"index": 0,
"startMs": 1800000,
"title": "Fargo"
},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"hidden": true,
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {
"collection": true,
"delete": true,
"download": true,
"edit": true,
"favorite": true,
"myList": true,
"play": true,
"playlist": true,
"queue": true,
"refresh": true,
"watched": true
},
"state": {
"containerRevision": 0,
"favorite": true,
"personalRevision": 0,
"rating": 0,
"watched": true,
"watchlisted": true
},
"watched": true
},
"homeTitleContext": {
"genres": [
"string"
],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"media": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"homeTitleContext": {
"genres": [],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
},
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {
"pivot": "string",
"query": {},
"sort": []
},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{
"name": "Fargo",
"position": "string"
}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
],
"failures": [
{
"code": "string",
"itemId": "id_8h2k4q"
}
],
"jobIds": [
"string"
],
"jobs": [
{
"command": "string",
"done": 0,
"errorCode": "string",
"failed": 0,
"failuresCursor": "eyJvIjoyMH0",
"jobId": "id_8h2k4q",
"state": "string",
"total": 0,
"totalKnown": true
}
],
"kind": "string",
"nextCursor": "eyJvIjoyMH0",
"pending": true,
"serverId": "id_8h2k4q",
"unknown": 0,
"unresolvedJobIds": [
"string"
],
"viewerFence": "string"
}- addedintegerrequired
- alreadyPresentintegerrequired
- completebooleanrequired
- destinationIdstringrequired
- failedintegerrequired
failureEntriesarray of objectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
failuresarray of objectrequired
- codestringrequired
- itemIdstringrequired
- jobIdsarray of stringrequired
jobsarray of objectrequired
- commandstringrequired
- doneintegerrequired
- errorCodestring
- failedintegerrequired
- failuresCursorstring
- jobIdstringrequired
- statestringrequired
- totalintegerrequired
- totalKnownbooleanrequired
- kindstringrequired
- nextCursorstringrequired
- pendingbooleanrequired
- serverIdstringrequired
- unknownintegerrequired
- unresolvedJobIdsarray of stringrequired
- viewerFencestringrequired
defaultRequest refused or unavailableapplication/json
{
"error": {
"code": "string",
"message": "string"
}
}errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestinvalid_cursorunauthorizednot_foundrevision_mismatchinternaltimeoutdatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/home/destination-receipt" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"cursor":"eyJvIjoyMH0","destinationId":"id_8h2k4q","jobIds":["string"],"kind":"string"}'GET/v1/home/layoutRead home layoutread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_home_layout
Responses
200Successapplication/json
{
"hiddenRowIds": [
"string"
],
"revision": 0,
"rowOrder": [
"string"
],
"rows": [
{
"artworkShape": "string",
"availabilityText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"hidden": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"reorderable": true,
"required": true,
"title": "Fargo",
"titleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
}
}
]
}- hiddenRowIdsarray of stringrequired
- revisionintegerrequired
- rowOrderarray of stringrequired
rowsarray of objectrequired
- artworkShapestringrequired
availabilityTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- hiddenbooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- reorderablebooleanrequired
- requiredbooleanrequired
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
defaultRequest refused or unavailableapplication/json
{
"error": {
"code": "string",
"message": "string"
}
}errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/home/layout" \
-H "Authorization: Bearer $PORTICO_API_KEY"PUT/v1/home/layoutSave home layoutplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
put_home_layout- Max body
- 64 KiB
Request body application/json · required
{
"expectedRevision": 0,
"hiddenRowIds": [
"string"
],
"idempotencyKey": "string",
"rowOrder": [
"string"
]
}- expectedRevisionintegerrequired
- hiddenRowIdsarray of stringrequired
- idempotencyKeystringrequired
- rowOrderarray of stringrequired
Responses
200Successapplication/json
{
"hiddenRowIds": [
"string"
],
"revision": 0,
"rowOrder": [
"string"
]
}- hiddenRowIdsarray of stringrequired0–64 items
- revisionintegerrequired
- rowOrderarray of stringrequired0–64 items
defaultRequest refused or unavailableapplication/json
{
"error": {
"code": "string",
"message": "string"
}
}errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundhome_layout_conflictinternaldatabase_busywriter_capacity
Example request
curl -X PUT "http://127.0.0.1:32500/v1/home/layout" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"hiddenRowIds":["string"],"idempotencyKey":"string","rowOrder":["string"]}'POST/v1/home/layout/resetRun home layout resetplayback
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the playback scope, or a signed-in session
- OpenAPI operation ID
post_home_layout_reset- Max body
- 64 KiB
Request body application/json · required
{
"expectedRevision": 0,
"hiddenRowIds": [
"string"
],
"idempotencyKey": "string",
"rowOrder": [
"string"
]
}- expectedRevisionintegerrequired
- hiddenRowIdsarray of stringrequired
- idempotencyKeystringrequired
- rowOrderarray of stringrequired
Responses
200Successapplication/json
{
"hiddenRowIds": [
"string"
],
"revision": 0,
"rowOrder": [
"string"
]
}- hiddenRowIdsarray of stringrequired0–64 items
- revisionintegerrequired
- rowOrderarray of stringrequired0–64 items
defaultRequest refused or unavailableapplication/json
{
"error": {
"code": "string",
"message": "string"
}
}errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity
Example request
curl -X POST "http://127.0.0.1:32500/v1/home/layout/reset" \
-H "Authorization: Bearer $PORTICO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expectedRevision":0,"hiddenRowIds":["string"],"idempotencyKey":"string","rowOrder":["string"]}'GET/v1/home/rows/{id}Page a composed Home rowread
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the read scope, or a signed-in session
- OpenAPI operation ID
get_home_row
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | |
limit | query | integer | ""≥ 1 | |
cursor | query | string | |
start | query | string | |
revision | query | string | |
anchorId | query | string | |
group | query | string | |
sourceId | query | string |
Responses
200Successapplication/json
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"children": [
{
"anchorId": "id_8h2k4q",
"artworkShape": "string",
"cacheTtlMs": 1800000,
"collection": {
"actions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"backdropUrl": "https://example.com/…",
"collection": {
"id": "id_8h2k4q",
"itemCount": 0,
"libraryId": "id_8h2k4q",
"name": "Fargo",
"origin": "string",
"revision": 0
},
"firstYear": 0,
"lastTitle": "Fargo",
"mediaKind": "string",
"members": [
{}
]
},
"critical": true,
"cursorCapable": true,
"deferred": false,
"displayTargets": [
{
"entryId": "id_8h2k4q",
"membershipId": "id_8h2k4q"
}
],
"endpoint": "string",
"entries": [
{
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {},
"albumCount": 0,
"albumType": "string",
"artist": {},
"artistType": "string",
"artworkPaths": [],
"audioFacts": {},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [],
"bookProgress": {},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [],
"hidden": true,
"homeActions": {},
"homeTitleContext": {},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {},
"libraryId": "id_8h2k4q",
"media": {},
"missing": true,
"narrators": [],
"navigation": {},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {},
"rating": 0,
"readingMark": {},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [],
"show": {},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {
"channels": [
{}
],
"expiresAt": "2026-10-18T19:30:00Z",
"group": "string",
"groups": [
{}
],
"observedAt": "2026-10-18T19:30:00Z",
"revision": "r12",
"sort": "favorites"
},
"nextCursor": "eyJvIjoyMH0",
"period": {
"days": 0,
"end": "string",
"metric": "string",
"start": "string",
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"platforms": [
"string"
],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {
"kind": "string",
"libraryId": "id_8h2k4q",
"source": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"text": {
"code": "string",
"fallback": "string",
"params": {}
}
},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [
{
"entryId": "id_8h2k4q",
"target": {}
}
],
"revision": {
"catalog": 0,
"viewer": 0
},
"seeAll": {
"group": "string",
"sourceId": "id_8h2k4q",
"type": "guide"
},
"start": 0,
"subtitleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"title": "Fargo",
"titleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"total": 0,
"viewerFence": "string",
"why": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"whyTitles": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
]
}
],
"collection": {
"actions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {
"collection": true,
"delete": true,
"download": true,
"edit": true,
"favorite": true,
"myList": true,
"play": true,
"playlist": true,
"queue": true,
"refresh": true,
"watched": true
},
"state": {
"containerRevision": 0,
"favorite": true,
"personalRevision": 0,
"rating": 0,
"watched": true,
"watchlisted": true
},
"watched": true
},
"backdropUrl": "https://example.com/…",
"collection": {
"id": "id_8h2k4q",
"itemCount": 0,
"libraryId": "id_8h2k4q",
"name": "Fargo",
"origin": "string",
"revision": 0
},
"firstYear": 0,
"lastTitle": "Fargo",
"mediaKind": "string",
"members": [
{
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"hidden": true,
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"homeTitleContext": {
"genres": [],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"media": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {},
"albumCount": 0,
"albumType": "string",
"artist": {},
"artistType": "string",
"artworkPaths": [],
"audioFacts": {},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [],
"bookProgress": {},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [],
"homeActions": {},
"homeTitleContext": {},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {},
"libraryId": "id_8h2k4q",
"missing": true,
"narrators": [],
"navigation": {},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {},
"rating": 0,
"readingMark": {},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [],
"show": {},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
},
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
]
},
"critical": true,
"cursorCapable": true,
"deferred": true,
"displayTargets": [
{
"entryId": "id_8h2k4q",
"membershipId": "id_8h2k4q"
}
],
"endpoint": "string",
"entries": [
{
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{
"bitDepth": 17,
"codec": "string",
"sampleRate": 1,
"variant": "lossless"
}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {
"endMs": 1800000,
"index": 0,
"startMs": 1800000,
"title": "Fargo"
},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"hidden": true,
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {
"collection": true,
"delete": true,
"download": true,
"edit": true,
"favorite": true,
"myList": true,
"play": true,
"playlist": true,
"queue": true,
"refresh": true,
"watched": true
},
"state": {
"containerRevision": 0,
"favorite": true,
"personalRevision": 0,
"rating": 0,
"watched": true,
"watchlisted": true
},
"watched": true
},
"homeTitleContext": {
"genres": [
"string"
],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"media": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"homeTitleContext": {
"genres": [],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
},
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {
"pivot": "string",
"query": {},
"sort": []
},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{
"name": "Fargo",
"position": "string"
}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
],
"evidenceId": "id_8h2k4q",
"explanation": "string",
"family": "string",
"hasMore": true,
"hideable": true,
"id": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"limit": 0,
"live": {
"channels": [
{
"actions": {
"favorite": true,
"play": true
},
"channel": {
"favorite": true,
"generation": "string",
"group": "string",
"hidden": true,
"id": "id_8h2k4q",
"logoPath": "string",
"mark": {},
"name": "Fargo",
"number": "string",
"preferenceRevision": 0,
"programmes": [],
"provenance": "string",
"recordAvailable": true,
"recordUnavailableReason": "string",
"serverHidden": true,
"sourceId": "id_8h2k4q",
"tuneAvailable": true,
"tuneUnavailableReason": "string"
},
"source": {
"availableEnd": "string",
"availableStart": "string",
"generation": "string",
"id": "id_8h2k4q",
"name": "Fargo",
"provenance": "string",
"publishedAt": "2026-10-18T19:30:00Z",
"refreshState": "string"
}
}
],
"expiresAt": "2026-10-18T19:30:00Z",
"group": "string",
"groups": [
{
"count": 0,
"name": "Fargo"
}
],
"observedAt": "2026-10-18T19:30:00Z",
"revision": "r12",
"sort": "favorites"
},
"nextCursor": "eyJvIjoyMH0",
"period": {
"days": 0,
"end": "string",
"metric": "string",
"start": "string",
"text": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
}
},
"platforms": [
"string"
],
"policyState": "string",
"priority": 0,
"privacySensitivity": "string",
"provider": "string",
"reason": {
"kind": "string",
"libraryId": "id_8h2k4q",
"source": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"text": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
}
},
"relation": "string",
"reorderable": true,
"required": true,
"resumes": [
{
"entryId": "id_8h2k4q",
"target": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"albumCount": 0,
"albumType": "string",
"artist": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"artistType": "string",
"artworkPaths": [
"string"
],
"audioFacts": {
"atmos": true,
"bitDepth": 0,
"channels": 0,
"codec": "string",
"layout": "string",
"lossless": true,
"sampleRate": 0
},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [
{}
],
"bookProgress": {
"bookId": "id_8h2k4q",
"chapter": {},
"durationMs": 1800000,
"itemId": "id_8h2k4q",
"partPositionMs": 1800000,
"positionMs": 1800000,
"remainingMs": 1800000
},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [
"string"
],
"hidden": true,
"homeActions": {
"collection": true,
"delete": true,
"details": true,
"download": true,
"editMetadata": true,
"favorite": true,
"myList": true,
"notInterested": true,
"play": true,
"played": true,
"playlist": true,
"queue": true,
"rating": true,
"refreshMetadata": true,
"removeFromContinue": true,
"selection": {},
"state": {},
"watched": true
},
"homeTitleContext": {
"genres": [],
"kind": "string",
"seasonCount": 0,
"year": 0
},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {
"airDate": "string",
"count": 0,
"episodeNumber": 0,
"seasonNumber": 0,
"title": "Fargo"
},
"libraryId": "id_8h2k4q",
"media": {
"absoluteNumber": 0,
"activeBeginYear": 0,
"activeEndYear": 0,
"addedAt": "2026-10-18T19:30:00Z",
"airDate": "string",
"album": {},
"albumCount": 0,
"albumType": "string",
"artist": {},
"artistType": "string",
"artworkPaths": [],
"audioFacts": {},
"author": "string",
"available": true,
"backdropUrl": "https://example.com/…",
"badges": [],
"bookProgress": {},
"contentRating": "string",
"count": 0,
"country": "string",
"dateBased": true,
"discNumber": 0,
"displayTitle": "Fargo",
"durationMs": 1800000,
"edition": "string",
"episodeNumber": 0,
"favorite": true,
"genres": [],
"homeActions": {},
"homeTitleContext": {},
"id": "id_8h2k4q",
"kind": "string",
"label": "string",
"language": "en",
"lastChanged": "string",
"latestEpisode": {},
"libraryId": "id_8h2k4q",
"missing": true,
"narrators": [],
"navigation": {},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {},
"rating": 0,
"readingMark": {},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [],
"show": {},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
},
"missing": true,
"narrators": [
"string"
],
"navigation": {
"browse": {},
"category": "string",
"channelId": "id_8h2k4q",
"entityId": "id_8h2k4q",
"provenance": "string",
"sourceId": "id_8h2k4q",
"view": "string"
},
"new": true,
"origin": "string",
"overview": "string",
"overviewSource": "string",
"overviewSourceUrl": "https://example.com/…",
"pageCount": 0,
"pinned": true,
"playback": {
"itemId": "id_8h2k4q",
"startMs": 1800000
},
"plays": 0,
"posterUrl": "https://example.com/…",
"progressMs": 1800000,
"publicationType": "book",
"publishedYear": 0,
"publisher": "string",
"radioSeed": {
"id": "id_8h2k4q",
"kind": "string"
},
"rating": 0,
"readingMark": {
"itemId": "id_8h2k4q",
"read": true,
"revision": 0
},
"releaseDate": "string",
"removed": true,
"resolution": "string",
"role": "string",
"seasonCount": 0,
"seasonNumber": 0,
"series": [
{}
],
"show": {
"id": "id_8h2k4q",
"name": "Fargo"
},
"sortLetter": "string",
"special": true,
"stillUrl": "https://example.com/…",
"subtitle": "Fargo",
"title": "Fargo",
"totalAtLeast": 0,
"trackNumber": 0,
"unwatchedCount": 0,
"userRating": 0,
"watched": true,
"watchedCount": 0,
"watchlisted": true,
"year": 0,
"yearMax": 0,
"yearMin": 0
}
}
],
"revision": {
"catalog": 0,
"viewer": 0
},
"seeAll": {
"group": "string",
"sourceId": "id_8h2k4q",
"type": "guide"
},
"start": 0,
"subtitleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"title": "Fargo",
"titleText": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"total": 0,
"viewerFence": "string",
"why": {
"code": "string",
"fallback": "string",
"params": {
"key": "string"
}
},
"whyTitles": [
{
"id": "id_8h2k4q",
"name": "Fargo"
}
]
}- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
childrenarray of object0–5 items
- anchorIdstring
- artworkShapestringrequired
- cacheTtlMsintegerrequired
collectionobject
actionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
- sortarray of objectrequired0–1 items
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredbooleanone of false
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
episodeobject
- displaystring
- numberinteger
- seasoninteger
- episodeIdstring
flagsobjectrequired
- livebooleanrequired
- newbooleanrequired
- premierebooleanrequired
- repeatbooleanrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
ratingobject
- systemstringrequired
- valuestringrequired
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
- sortarray of objectrequired0–1 items
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
collectionobject
actionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
- backdropUrlstring
collectionobjectrequired
- idstringrequired
- itemCountintegerrequired
- libraryIdstringrequired
- namestringrequired
- originstringrequired
- revisionintegerrequired
- firstYearinteger
- lastTitlestring
- mediaKindstringrequired
membersarray of objectrequired0–4 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- criticalbooleanrequired
- cursorCapablebooleanrequired
- deferredboolean
displayTargetsarray of object0–60 items
- entryIdstringrequired
- membershipIdstringrequired
- endpointstringrequired
entriesarray of objectrequired0–200 items
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- evidenceIdstring
- explanationstring
- familystring
- hasMorebooleanrequired
- hideablebooleanrequired
- idstringrequired
- kindstringrequired
- libraryIdstring
- limitintegerrequired
liveobject
channelsarray of objectrequired0–50 items
actionsobjectrequired
- favoritebooleanrequired
- playbooleanrequired
channelobjectrequired
- favoritebooleanrequired
- generationstringrequired
- groupstringrequired
- hiddenbooleanrequired
- idstringrequired
- logoPathstring
markobject
- seedstringrequired
- textstringrequired
- namestringrequired
- numberstringrequired
- preferenceRevisionintegerrequired
programmesarray of objectrequired
- categoriesarray of stringrequired
- channelIdstringrequired
- descriptionstring
- endstringrequired
episodeobject
- displaystring
- numberinteger
- seasoninteger
- episodeIdstring
flagsobjectrequired
- livebooleanrequired
- newbooleanrequired
- premierebooleanrequired
- repeatbooleanrequired
- idstringrequired
- imagestring
- lineagestringrequired
- newEvidencestring
ratingobject
- systemstringrequired
- valuestringrequired
- recordingIdstring
- recordingStatestring
- seriesIdstring
- starRatingstring
- startstringrequired
- subtitlestring
- titlestringrequired
- yearinteger
- provenancestringrequired
- recordAvailablebooleanrequired
- recordUnavailableReasonstringrequired
- serverHiddenbooleanrequired
- sourceIdstringrequired
- tuneAvailablebooleanrequired
- tuneUnavailableReasonstringrequired
sourceobjectrequired
- availableEndstringrequired
- availableStartstringrequired
- generationstringrequired
- idstringrequired
- namestringrequired
- provenancestringrequired
- publishedAtstringrequired
- refreshStatestringrequired
- expiresAtstringrequired
- groupstringrequired
groupsarray of objectrequired0–2000 items
- countintegerrequired
- namestringrequired
- observedAtstringrequired
- revisionstringrequired
- sortstringrequiredone of "favorites"
- nextCursorstringrequired
periodobject
- daysintegerrequired
- endstringrequired
- metricstringrequired
- startstringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- platformsarray of string
- policyStatestringrequired
- priorityintegerrequired
- privacySensitivitystringrequired
- providerstring
reasonobject
- kindstringrequired
- libraryIdstring
sourceobject
- idstringrequired
- namestringrequired
textobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- relationstring
- reorderablebooleanrequired
- requiredbooleanrequired
resumesarray of object
- entryIdstringrequired
targetobjectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
mediaobject
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | nullrequired
- airDatestring
albumobject
- idstringrequired
- namestringrequired
- albumCountinteger
- albumTypestring
artistobject
- idstringrequired
- namestringrequired
- artistTypestring
- artworkPathsarray of string
audioFactsobject
- atmosboolean
- bitDepthinteger
- channelsinteger
- codecstringrequired
- layoutstring
- losslessboolean
- sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
badgesarray of object0–2 items
- bitDepthintegerrequired≥ 17
- codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
- sampleRateintegerrequired≥ 1
- variant"lossless"required
bookProgressobject
- bookIdstringrequired
chapterobject
- endMsintegerrequired
- indexintegerrequired
- startMsintegerrequired
- titlestringrequired
- durationMsinteger
- itemIdstringrequired
- partPositionMsintegerrequired
- positionMsinteger
- remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
homeActionsobject
- collectionbooleanrequired
- deletebooleanrequired
- detailsbooleanrequired
- downloadbooleanrequired
- editMetadatabooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- notInterestedboolean
- playbooleanrequired
- playedbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- ratingbooleanrequired
- refreshMetadatabooleanrequired
- removeFromContinueboolean
selectionobjectrequired
- collectionbooleanrequired
- deletebooleanrequired
- downloadbooleanrequired
- editbooleanrequired
- favoritebooleanrequired
- myListbooleanrequired
- playbooleanrequired
- playlistbooleanrequired
- queuebooleanrequired
- refreshbooleanrequired
- watchedbooleanrequired
stateobjectrequired
- containerRevisionintegerrequired
- favoritebooleanrequired
- personalRevisionintegerrequired
- ratingnumber | any | nullrequired
- watchedbooleanrequired
- watchlistedbooleanrequired
- watchedbooleanrequired
homeTitleContextobject
- genresarray of stringrequired
- kindstringrequired
- seasonCountinteger
- yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
latestEpisodeobject
- airDatestringrequired
- countintegerrequired
- episodeNumberintegerrequired
- seasonNumberinteger
- titlestring
- libraryIdstring
- missingbooleanrequired
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestringrequired
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
- missingboolean
- narratorsarray of string
navigationobject
browseobject
- pivotstringrequiredlength 1–256
- queryobject
sortarray of objectrequired0–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequired
- categorystring
- channelIdstring
- entityIdstring
- provenancestring
- sourceIdstring
- viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
playbackobject
- itemIdstringrequired
- startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
radioSeedobject
- idstringrequired
- kindstringrequired
- ratingnumber
readingMarkobject
- itemIdstringrequired
- readbooleanrequired
- revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
seriesarray of object
- namestringrequired
- positionstring
showobject
- idstringrequired
- namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
revisionobjectrequired
- catalogintegerrequired
- viewerintegerrequired
seeAllobject
- groupstringlength 1–256
- libraryIdstringlength 1–256
- pivotstringlength 1–256
- queryobject
- resourceIdstringlength 1–256
- rowIdstringlength 1–256
sortarray of object1–1 items
- directionstringrequiredone of "asc", "desc"
- fieldstringrequiredlength 1–256
- sourceIdstringlength 1–256
- typestringrequiredone of "library", "row", "saved_view", "collection", "guide"
- startintegerrequired
subtitleTextobject
- codestringrequired
- fallbackstringrequired
- paramsobject
- titlestringrequired
titleTextobjectrequired
- codestringrequired
- fallbackstringrequired
- paramsobject
- totalintegerrequired
- viewerFencestringrequired
whyobject
- codestringrequired
- fallbackstringrequired
- paramsobject
whyTitlesarray of object0–3 items
- idstringrequired
- namestringrequired
defaultRequest refused or unavailableapplication/json
{
"error": {
"code": "string",
"message": "string"
}
}errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestinvalid_cursorstale_continuationunauthorizednot_permittednot_foundrate_limitedinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/home/rows/{id}" \
-H "Authorization: Bearer $PORTICO_API_KEY"No operations match that filter.