Screener Room Details
watch.content.screener_room.retrieve
Returns details of the screener room.
The screener room can be identified either by its key or by a passcode issued for it. Passcode based access supports viewing a link type screener through Cinema by Indee, where the viewer enters a passcode instead of following a link.
Endpoint
GET v2/watch/content/screener-rooms/{screener_room_key}
GET v2/watch/content/screener-rooms/{passcode}
The last path segment is resolved as a screener room key first. If no screener room matches, it is treated as a passcode.
A passcode is single use — once it resolves successfully it is revoked, and a further request with the same passcode is rejected. Passcode access additionally requires the ClientID platform to have an app configured for the watch product, on a version at or above its minimum.
Headers
| Header | Value |
|---|---|
| Authorization | Bearer api_key |
| ClientID | platform-\<id>-app_version-\<id> |
The ClientID header is required. It must have four hyphen-separated components, and the first component must be one of web, roku, firestick, fireos, appletv, ipad, tizen.
Response Body
{
"key": <str>,
"force_login": <bool>,
"recipient": {
"email": <str>,
"name": <str>,
},
"project": {
"key": <str>,
"name": <str>,
"episodic": <bool>,
"seasons": [<int>],
"poster": <url> | null,
"banner": <url> | null,
"video_banner": <url> | "",
"description": <str>,
"cast_and_crew": [
{
"name": <str>,
"role": <str>
},
.
.
],
"in_watchlist": <bool>,
"watch_on_tv": <bool>,
},
"status_code": <status_code>,
"status_message": <str>
}
| Field | Type | Description |
|---|---|---|
key |
String | Unique key of the screener room. Returned even when the room was resolved by passcode. |
force_login |
Boolean | Whether the viewer must sign in before playback. |
recipient |
JSON | The person the screener was sent to. null unless the screener was sent by email. |
recipient.email |
String | Email address of the recipient. |
recipient.name |
String | Name of the recipient. |
project |
JSON | Details of the title in the screener room. |
project.key |
String | Unique key of the project. |
project.name |
String | Name of the project. |
project.episodic |
Boolean | Whether the project is episodic. |
project.seasons |
JSON | Season numbers available to the viewer. Empty for non-episodic projects. A season recorded without a number is reported as 0. |
project.poster |
String | Link to the poster image. |
project.banner |
String | Link to the banner image. |
project.video_banner |
String | Link to the video banner. Empty string when video banners are not enabled for the watch product. |
project.description |
String | Description of the project. |
project.cast_and_crew |
JSON | List of cast and crew members, each with a name and a role. |
project.in_watchlist |
Boolean | Whether the project is in the viewer's watchlist. Always false on this endpoint, which has no viewer context. |
project.watch_on_tv |
Boolean | Whether watching on TV is available on the plan for this title. |
status_code |
String | The Indee status code for the response. |
status_message |
String | Human readable message describing the response. |
Status Codes
| Indee status code | HTTP Response Code | Description |
|---|---|---|
| W0000 | HTTP 200 | Success |
| W2000 | HTTP 401 | Authorization header was either not passed or there was some issue parsing it |
| W2001 | HTTP 401 | API key is invalid or expired, or is not fully configured |
| W2003 | HTTP 401 | Invalid auth token |
| W2009 | HTTP 401 | ClientID header was either not passed or is malformed |
| W2101 | HTTP 403 | API key not authorized to perform this action |
| W2108 | HTTP 403 | Watch product is inactive |
| W2102 | HTTP 451 | Request blocked by geofencing for the resolved region |
| W4202 | HTTP 400 | The value passed is neither a known screener room key nor a well formed passcode |
| W4203 | HTTP 400 | The passcode does not exist |
| W4204 | HTTP 400 | The passcode has expired or has already been used |
| W4901 | HTTP 400 | No app is configured for the requesting platform on this watch product |
| W4908 | HTTP 403 | The requesting app is below the minimum supported version |
| W5001 | HTTP 429 | Rate limited |
| W5000 | HTTP 500 | Unknown server error occurred |