Board events

Description

Returns all events on the board filtered by a time period. You are required to give at least one from or to timestamp. If you want to give a timestamp for 1 January 2023 05:30 (UTC), you can either use 2023-01-01T05:30Z or 1672551000000 (time since epoch). A maximum of 100 events are returned.

Request format

curl https://kanbanflow.com/api/v1/board/events?from=<TIMESTAMP>&to=<TIMESTAMP>

Example request

curl "https://kanbanflow.com/api/v1/board/events?from=2023-01-01T00:00Z&to=2023-01-02T00:00Z"

Example response

{
    "_id": "EB8eEYnSp",
    "timestamp": "2023-01-01T17:45:21Z",
    "userId": "UHJ9JgtA",
    "detailedEvents": [
        {
            "eventType": "taskChanged",
            "taskId": "T3s6UGyzY",
            "changedProperties": [
                {
                    "property": "color",
                    "oldValue": "blue",
                    "newValue": "red"
                }
            ]
        }
    ]
}

Task events

Description

Returns all events for a task filtered by a time period. You are required to give at least one from or to timestamp. If you want to give a timestamp for 1 January 2023 05:30 (UTC), you can either use 2023-01-01T05:30Z or 1672551000000 (time since epoch). A maximum of 100 events are returned.

Request format

curl https://kanbanflow.com/api/v1/tasks/<TASK_ID>/events?from=<TIMESTAMP>&to=<TIMESTAMP>

Example request

curl "https://kanbanflow.com/api/v1/tasks/T3s6UGyzY/events?from=2023-01-01T00:00Z"

Example response

{
    "_id": "EB8eEYnSp",
    "timestamp": "2023-01-01T17:45:21Z",
    "userId": "UHJ9JgtA",
    "detailedEvents": [
        {
            "eventType": "taskChanged",
            "taskId": "T3s6UGyzY",
            "changedProperties": [
                {
                    "property": "color",
                    "oldValue": "blue",
                    "newValue": "red"
                }
            ]
        }
    ]
}