Swimlane Project List

watch.content.swimlane_project.list

This API returns the titles that make up a given swimlane, in the order they are arranged within it.

Headers

Header Value
Authorization JWT token

Endpoint

GET v3/watch/content/swimlanes/{swimlane_key}/projects

Query Parameters

Parameter Type Required Description
brand String Optional Restrict the titles to those published under the given brand. If not passed, the all-encompassing allprojects brand (ie. all projects published to the user/audience) is used.
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 9 and the maximum allowed value is 15.

Response Body

    {
        "count": 30,
        "previous": "example.com",
        "next": "example.com",
        "results": [
            {
                "position": 1,
                "project": {
                    "key": "prj-01hj35p9e3pv2hbwzksjzn8gxx",
                    "name": "ABC",
                    "poster": "poster-url-1"
                }
            },
            .
            .
        ],
        "status_code": "W0000",
        "status_message": "Success"
    }
Field Type Description
count Integer The total count of results without pagination.
previous String Link to the previous set of results.
next String Link to the next set of results.
results JSON Results of the swimlane project listing.
results[].position Integer The sequence position of the title within the swimlane.
results[].project JSON The details of the title.
results[].project.key String The unique identifier for the project.
results[].project.name String Name of the project.
results[].project.poster String Link to the project poster.
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
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
W4201 HTTP 403 The specified swimlane key does not exist in Indee
W4902 HTTP 400 Invalid brand
W5001 HTTP 429 Rate limited
W5000 HTTP 500 Unknown server error occurred