Get all Projects
This API fetches the list of projects and their metadata available for the logged-in user.
Headers
The JWT Access token should be passed in the authorization header for all APIs.
Header | Value |
---|---|
Authorization | JWT token |
Endpoint
Query Parameters
Parameter | Type | Requirement | Description |
---|---|---|---|
q |
String | Optional | Filter projects by substring in the name. |
active_only |
Boolean | Optional | Filter active/inactive projects. |
page |
Integer | Optional | Page number of the results. Default value is 1. |
limit |
Integer | Optional | Number of results per page. Default value is 12. You can define the limit to a maximum of 30. |
Response Body
{
"status_code": "A0000",
"status_message": "success",
"count": 24,
"results": [
{
"key": "prj-01hpr6t70xedtepht8b196krsy",
"ext_project_id": "project-id-596afghhxx",
"release_year": 2020,
"genres": [
{
"key": "gnr-01fwzm9p60wsf5t4s3tye8r42a",
"name": "Horror",
"description": "Horror movies"
}
],
"description": "<p>The project description</p>",
"poster": {
"url": "https://media.devtest.indee.tv/2582/2582_poster_1908335069.jpg?Expires=1708433103&Signature=SLya1ftOiEMsr1-3Ud5t3ufOcTORgU0aLMZoRxUb1TpjMKcPYQJXlrXSt8DgpLo87HjKtvkOY6kw5sylAjUY5P~hMbvr7S5Ow9Wog3Il2fzOZVVbYv8kKrkD8RUjKmPYL1k0e8D0M~npByY~hQq0RxmSyfEi~bNuOSn~jjr7BbU4pvp58Kp4EOv4iJxjYseSF~Ft8bpbNONpSeehRNRLTfL19YYOp5xwXkqcp2~LnfoKyQ9nyWktsDqXF29rnQUgV0D83VucpvE-fp-CAsPZzxuy0qskaq-o2qdB1ikJ3ruWf8vmAvXi8BDM8iSRmxTh3nwkVIlC3e3L15fDeoK4pw__&Key-Pair-Id=K2NTQVU4FZL5P0",
"status_code": "A3002",
"status_message": "Project poster added successfully"
},
"banner": {
"url": "https://media.devtest.indee.tv/2582/2582_banner_1908335069.jpg?Expires=1708433103&Signature=SLya1ftOiEMsr1-3Ud5t3ufOcTORgU0aLMZoRxUb1TpjMKcPYQJXlrXSt8DgpLo87HjKtvkOY6kw5sylAjUY5P~hMbvr7S5Ow9Wog3Il2fzOZVVbYv8kKrkD8RUjKmPYL1k0e8D0M~npByY~hQq0RxmSyfEi~bNuOSn~jjr7BbU4pvp58Kp4EOv4iJxjYseSF~Ft8bpbNONpSeehRNRLTfL19YYOp5xwXkqcp2~LnfoKyQ9nyWktsDqXF29rnQUgV0D83VucpvE-fp-CAsPZzxuy0qskaq-o2qdB1ikJ3ruWf8vmAvXi8BDM8iSRmxTh3nwkVIlC3e3L15fDeoK4pw__&Key-Pair-Id=K2NTQVU4FZL5xx",
"status_code": "A3006",
"status_message": "Project banner added successfully"
},
"name": "film",
"cast": [
{
"name": "Mark",
"role": "Actor"
},
{
"name": "Susan",
"role": "Actress"
}
]
"type": "feature"
},
],
"previous": "api url to previous page",
"next": "api url to next page"
}
Field | Type | Description |
---|---|---|
status_code |
String | Indee provided status code. |
status_message |
String | The message associated with the status code. |
count |
String | The number of results per page. |
ext_project_id |
String | A customer provided unique ID for the project. |
name |
String | The name of the project. |
description |
String | A description of the project. |
genres |
Array | A collection of genres for the project from a predefined list. |
type |
String(choice(series/feature)) | Type of content |
poster |
dict | A dictionary containing url and status for the project poster. |
banner |
dict | A dictionary containing url and status for the project banner. |
cast |
Array | A collection of pairs of role and name. |
release_year |
int | Release year |
Error and Success Codes
For error codes and success codes, see Common Error Codes section.
Note
Client Development Notes: The poster and banner URLs will be valid only for 1 hour. Please use the API response for displaying the banner/poster.