Swimlane Listing

watch.content.swimlane.list

This API returns the curated collections of titles published to the authenticated user in the form of swimlanes. Only the details of each swimlane are returned; use the swimlane project listing API to fetch the titles within a swimlane.

Headers

Header Value
Authorization JWT token

Endpoint

GET v3/watch/content/swimlanes

Query Parameters

Parameter Type Required Description
brand String Optional Filter swimlanes by brand. If not passed, the swimlanes set for the all-encompassing allprojects brand (ie. 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. The default value is 9 and the maximum allowed value is 15.

Response Body

    {
        "count": 30,
        "previous": "example.com",
        "next": "example.com",
        "results": [
            {
                "key": "swl-01hj35p9e3pv2hbwzksjzn8gxx",
                "name": "ABC",
                "position": 2
            },
            .
            .
        ],
        "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 listing.
results[].key String The unique identifier for the swimlane.
results[].name String Name of the swimlane.
results[].position Integer The sequence position of the swimlane in the listing.
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
W4900 HTTP 400 No swimlane configuration could be resolved for the request
W4902 HTTP 400 Invalid brand
W5001 HTTP 429 Rate limited
W5000 HTTP 500 Unknown server error occurred