Get task by ID

Description

Returns a single task by ID.

Query parameters

includePosition: Include the task's position in the column/swimlane it is in.

Request format

curl https://kanbanflow.com/api/v1/tasks/<TASK_ID>

Example request

curl https://kanbanflow.com/api/v1/tasks/T3s6UGyzY

Example response

{
    "_id": "T3s6UGyzY",
    "name": "Write report",
    "description": "",
    "color": "red",
    "columnId": "C9LIn5sEEpqT"
}

Response properties

Get tasks by column

Description

Returns all tasks in a column that is found either by id, name or index.

When there are more tasks to fetch in the column, the response will have tasksLimited=true and a nextTaskId, which points at the next task in line. Pass it in the next request as startTaskId to retrieve the succeeding tasks.

See Get task by ID for details of included properties for the individual tasks.

Request format

curl https://kanbanflow.com/api/v1/tasks?<PARAM_1>=<PARAM_VALUE_1>&<PARAM_2>=<PARAM_VALUE_2>&...<PARAM_N>=<PARAM_VALUE_N>

Please note that you should URL encode the parameter, especially if it contains spaces.

Example request (id)

curl https://kanbanflow.com/api/v1/tasks?columnId=CBO1VNGqDc4K

Example request (name)

curl "https://kanbanflow.com/api/v1/tasks?columnName=In%20progress"

Example request (index)

curl https://kanbanflow.com/api/v1/tasks?columnIndex=2

Example request (startTaskId, limit, order)

curl https://kanbanflow.com/api/v1/tasks?columnId=CBO1VNGqDc4K&startTaskId=T3s6UGyzY&limit=50&order=desc

Example request (startGroupingDate, limit, order)

curl https://kanbanflow.com/api/v1/tasks?columnId=CBO1VNGqDc4K&startGroupingDate=2023-10-01&limit=50&order=asc

Example response

[
    {
        "columnId": "CBO1VNGqDc4K",
        "columnName": "In progress",
        "tasksLimited": false,
        "tasks": [
            {
                "_id": "T3s6UGyzY",
                "name": "Write report",
                "description": "",
                "color": "red",
                "columnId": "CBO1VNGqDc4K"
            }
        ]
    }
]

Valid parameters

Get tasks by swimlane and column

Description

Returns all tasks in the cell confined by a column and swimlane. Both column and swimlane can be given by id, name or index. For date grouped columns, the number of tasks returned will be limited to 20 by default, but the limit is customizable (up to 100). When there are more tasks to fetch in the column, the response will have tasksLimited=true and a nextTaskId, which points at the next task in line. Pass it in the next request as startTaskId to retrieve the succeeding tasks. Instead of startTaskId, startGroupingDate can be used to start at a certain date (date finished). Format: YYYY-MM-DD. It is also possible to specify in which order tasks should be returned, either ascending (asc) or descending (desc). Default: desc.

See Get task by ID for details of included properties for the individual tasks.

Request format

curl https://kanbanflow.com/api/v1/tasks?<PARAM_1>=<PARAM_VALUE_1>&<PARAM_2>=<PARAM_VALUE_2>&...<PARAM_N>=<PARAM_VALUE_N>

Please note that you should URL encode the parameter, especially if it contains spaces.

Example request (swimlaneId, columnId)

curl https://kanbanflow.com/api/v1/tasks?swimlaneId=SqEB6zxG41e2&columnId=CBO1VNGqDc4K

Example request (startTaskId, limit, order)

curl https://kanbanflow.com/api/v1/tasks?swimlaneId=SqEB6zxG41e2&columnId=CBO1VNGqDc4K&startTaskId=T3s6UGyzY&limit=50&order=desc

Example request (startGroupingDate, limit, order)

curl https://kanbanflow.com/api/v1/tasks?swimlaneId=SqEB6zxG41e2&columnId=CBO1VNGqDc4K&startGroupingDate=2023-10-01&limit=50&order=asc

Example response

[
    {
        "swimlaneId": "SqEB6zxG41e2",
        "swimlaneName": "Team Beta",
        "columnId": "CBO1VNGqDc4K",
        "columnName": "In progress",
        "tasksLimited": false,
        "tasks": [
            {
                "_id": "T3s6UGyzY",
                "name": "Write report",
                "description": "",
                "color": "red",
                "columnId": "CBO1VNGqDc4K",
                "swimlaneId": "SqEB6zxG41e2"
            }
        ]
    }
]

Valid parameters

Get all tasks

Description

Returns all tasks on a board. For date grouped columns, it will only return a maximum of 20 tasks per cell. If it has more than 20 tasks tasksLimited=true in the response. To get more tasks for a specific cell, take a look at Get tasks by swimlane and column.

See Get task by ID for details of included properties for the individual tasks.

Request format

curl https://kanbanflow.com/api/v1/tasks

Example response

[
    {
        "columnId": "C9LIn5sEEpqT",
        "columnName": "To-do",
        "tasksLimited": false,
        "tasks": [
            {
                "_id": "T3s6UGyzY",
                "name": "Write report",
                "description": "",
                "color": "red",
                "columnId": "C9LIn5sEEpqT"
            }
        ]
    },
    {
        "columnId": "CAtDNYBBuU04",
        "columnName": "Do today",
        "tasksLimited": false,
        "tasks": []
    },
    {
        "columnId": "CBO1VNGqDc4K",
        "columnName": "In progress",
        "tasksLimited": false,
        "tasks": []
    },
    {
        "columnId": "COxkPjd0wra4",
        "columnName": "Done",
        "tasksLimited": false,
        "tasks": []
    }
]