Skip to content

Watchlist

WatchList - Project Listing

Returns all the projects added by the authenticated user to the watchlist

Headers

Header Value
Authorization JWT token

Endpoint

GET v2/watch/content/watchlist/projects

Query Parameters

  • q : Optional. Filter projects by substring in the name
  • genre : Optional. Filter projects by genre
  • brand : Optional. Filter projects by brand. If not passed, the projects from the all-encompassing allprojects brand (ie. all projects published to the user/audience) will be returned.
  • page : Optional. Default - 1. Page number of the results
  • limit : Optional. Default - 12. Max - 30. Number of results per page

Response Body

    {
        "count": 30,
        "previous": "example.com",
        "next": "example.com",
        "results": [
            {
                "key": <str>,
                "name": <str>,
                "poster": <str>
            }
            .
            .
        ]
    }
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 identifier for the extra.
name String Name of the project.
poster String Link for the project poster.

Status Codes

Indee status code HTTP Response Code Description
W0000 HTTP 200 Success
W0001 HTTP 200 No Content
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
W2104 HTTP 403 Feature not available
W4902 HTTP 400 Invalid Brand
W4903 HTTP 400 Invalid Genre
W5001 HTTP 429 Rate limited
W5000 HTTP 500 Unknown server error occurred

WatchList - Project Addition

This API helps in adding a project to the authenticated users watchlist

Headers

Header Value
Authorization JWT token

Endpoint

POST v2/watch/content/watchlist/projects

Request Body

    {
        "project_key": <project_key>
    }
Field Type Description
project_key String The unique identifier for the project.

Status Codes

Indee status code HTTP Response Code Description
W1003 HTTP 200 Project successfully added to watchlist
W1004 HTTP 200 Project added but watchlist projects limit reached, removed earliest project
W2000 HTTP 401 Authorization header was either not passed or there was some issue parsing it
W2003 HTTP 401 Invalid auth token
W2100 HTTP 403 API key not authorized to perform this action
W2104 HTTP 403 Feature not available
W4002 HTTP 400 The specified project key does not exist in Indee
W4005 HTTP 403 Permission Denied.
W4906 HTTP 400 Project is already added in watchlist
W5001 HTTP 429 Rate limited
W5000 HTTP 500 Unknown server error occurred

WatchList - Project Removal

This API helps in removing a project from the authenticated users watchlist

Headers

Header Value
Authorization JWT token

Endpoint

DEL v2/watch/content/watchlist/projects/<span style="color:red">{project_key}</span>

Status Codes

Indee status code HTTP Response Code Description
W1005 HTTP 200 Project Successfully removed from watchlist
W2000 HTTP 401 Authorization header was either not passed or there was some issue parsing it
W2003 HTTP 401 Invalid auth token
W2100 HTTP 403 API key not authorized to perform this action
W2104 HTTP 403 Feature not available
W4002 HTTP 400 The specified project key does not exist in Indee
W4005 HTTP 403 Permission Denied.
W4907 HTTP 400 Project cannot be removed as it does not exist in watchlist
W5001 HTTP 429 Rate limited
W5000 HTTP 500 Unknown server error occurred