Video Listing

Returns all the videos that an authenticated user can access for viewing and filtering.

Headers

Header	Value
Authorization	JWT token

Endpoint

GET v2/watch/content/projects/{project_key}/videos

Query Parameters

Parameter	Type	Required	Description
q	String	Optional	Filter videos by substring in the name.
season	String	Optional	Filter videos by season in case of episodic projects.
page	Integer	Optional	Page number of the results. The default value is 1.
limit	Integer	Optional	Number of results per page. The default value is 12. You can set it up to 30.

Response Body

    {
        "count": 30,  
        "next": "example.com",
        "previous": "example.com",
        "results": [
            {
            "key": "vid-01j1pagnn41xv3hwg8v3sqbmxx",
            "name": "ABC",
            "poster": "example.com",
            "duration_in_seconds": 120,
            "cast_and_crew": <json>, 
            "description": <str>, 
            "subtitles": <json>,
            "is_cmaf_enabled": true,
            "season": 3,
            "episode": 27,
            "original_air_date": <iso date>,
            "screening_details": {
                "expired": false,
                "max_views": 10,
                "views_consumed": <int>,
                "start_date": <int>, # epoch timestamp
                "expiry_date": <int> # epoch timestamp
            },
            "resume_playback":{
                "from_second":<int>
            },
            "auth_details": {
                "password_auth": <bool>,
                "two_fa_auth": <bool>
            },
            "overlay_watermark_details": {
                "text": "b6979d3901",
                "opacity": 60,
                "position": 1,
                "interval_in_seconds": 300,
                "duration_in_seconds": 20,
                "image_link": "https://media.indee.tv/524/video/5766/screener/scn-01hymr1mq2bb2gjvq5fjptq8ehpxvlhv.png?Expires=1734168940&Signature=nW85-SWjwKjWEb8iB4BC4dpddfn9LAvyQd~yXWNBujU9mWxJa4mXTbRgGcvANa5kHR27qT8RvZ2Up0XbOqn8UmwvO~P3qkFZQEsIW0wEs2vutUNzzzEwzYNTwwhPzLS-HRH7vJ9YKzrQaFkgEhWgr2NbeWghCyyWiGPI2HdXOyvEG2pglBxNHG047hkX0sJoIckxlrocB9F~4kNlElgl09um0K1CvMTM1qqlY~4RO8OgsIc5m4VOR7T4xwEWoVG4xMARp9DPKPbxPCT4-x4tjtJHJ6owPEVpAI5rvZNDINNa3jyp-VNqh15rvgvsHdWDLzUb~UGM6NhkT7p69eYM6Q__&Key-Pair-Id=K3HM5NS5Q9EXLB"
            }
            },
            .
            .
            .
        ]
    }

Field	Type	Description
count	Integer	Total count of the results w/o pagination.
next	String	Next page of results.
previous	String	Previous page of results.
key	String	The unique key for the video.
name	String	Name of the project.
poster	URL	Link for the project poster image.
duration_in_seconds	Integer	Video duration in seconds.
cast_and_crew	String	Cast and crew details for the video.
description	String	Description for the video.
subtitles	String	Subtitle details for the video.
is_cmaf_enabled	Boolean	Indicates whether the video stream is CMAF (https://www.wowza.com/blog/what-is-cmaf).
episode	Boolean	Episode number that the video is tied to. This is present if the project is episodic, else null.
seasons	Integer	List of seasons if the project is episodic. Empty array is returned if the project is not episodic.
original_air_date	ISO date	The original air date for the video in ISO format.
screening_details	String	This contains screening-related details for the video like the view count data, expiry etc.
expired	Boolean	Indicates whether or the video is available for viewing.
max_views	Integer	The number of views which were available on the video.
views_consumed	Integer	The number of views consumed so far.
start_date	Integer	The time from which the video was available for viewing.
auth_details	JSON	This contains auth-related details for the video such as whether it requires a password or a pass code to play.
password_auth	Boolean	Indicates whether the video needs password to play.
two_fa_auth	Boolean	Indicates whether the video needs a passcode to play.
resume_playback	JSON	Contains the details for enabling resume playback functionality.
from_second	Integer	Second from which the playback needs to be resumed from.
overlay_watermark_details	JSON	Contains the details for the overlay watermark which the viewing application needs to put on top of the video stream.
text	String	The overlay watermark text.
opacity	Integer	Opacity level (in percentage) for the overlay watermark.
position	Integer	Position for the overlay watermark (15-point grid).
interval_in_seconds	Integer	The interval in seconds at which the overlay watermark needs to be displayed (If this is 0, it means the overlay watermark should appear throughout the duration of the video).

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
W2003	HTTP 401	Invalid auth token
W2101	HTTP 403	API key not authorized to perform this action
W5001	HTTP 429	Rate limited
W5000	HTTP 500	Unknown server error occurred