Carousel Image Listing

watch.content.carousel_image.list

This API returns the promotional carousel images for the authenticated user which link to featured projects. The images can be customized for brands.

Headers

Header	Value
Authorization	JWT token

Endpoint

GET v2/watch/content/carousel-images

Query Parameters

Parameter	Type	Required	Description
brand	String	Optional	Filter carousel images by brand. If not passed, the carousel images set for the all-encompassing allprojects brand (i.e., all projects published to the user/audience) are returned.
page	Integer	Optional	Page number of the results. The default value is 1.
limit	Integer	Optional	Number of results per page.

Response Body

    {
        "count": 30,
        "previous": "example.com",
        "next": "example.com",
        "results": [
            {
                "link": <str>,
                "link_portrait": <str>,
                "position": <int>,
                "project": {
                    "key": "ABCDXYZ",
                    "name": <str>,
                    "poster": <str>
                } | null,
            },
        ]
    }

Field	Type	Description
count	Integer	The total count of results with pagination.
previous	URL	Link to the previous set of results.
next	URL	Link to the next set of results.
link	String	Link to the image.
link_portrait	String	Link to the image which is shown if the user is on a device with a smaller viewport; for example, mobile phone.
position	Integer	The sequence position of the carousel image.
project	JSON	The details of the project.
key	String	The unique identifier for the project.
name	String	The project name.
poster	String	Link for the project poster.

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