list kanban project

interface address:

  • /api/kanban/project/list

HTTP request method:

  • GET

request params:

  • None (login required)

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/kanban/project/list"

response example：

  • JSON:

    {
    "code": 0,
    "message": "",
    "data": {
        "list": [
            {
               "name":       "",
                "id":         "",
                "creator_id": "",
                "team_id":    "",
                "color":      "",
                "icon":       "",
                "icon_color": "",
                "name_color": "",
            },
        ],
        "uid": "1234567890",
        "email": "hello@example.com",
    },
}

create kanban project

interface address:

  • /api/kanban/project/create

HTTP request method:

  • POST

request params:

  • name (form, required): project name

  • team_id (form, optional): team ID

  • after_id (form, optional): project ID to place after it when sorting

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/project/create" -d "name=我的看板"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}

move kanban project

interface address:

  • /api/kanban/project/move

HTTP request method:

  • POST

request params:

  • id (form, required): project ID

  • after_id (form, optional): project ID to place after it when moving

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/project/move" -d "id=1&after_id=2"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

update kanban project

interface address:

  • /api/kanban/project/update

HTTP request method:

  • POST

request params:

  • id (form, required): project ID

  • name (form, optional): name

  • color (form, optional): color

  • icon (form, optional): icon

  • name_color (form, optional): name color

  • icon_color (form, optional): icon color

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/project/update" -d "id=1&name=新名称"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

delete kanban project

interface address:

  • /api/kanban/project/delete

HTTP request method:

  • POST

request params:

  • id (form, required): project ID

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/project/delete"

response example：

  • JSON:

    {
}

create kanban list

interface address:

  • /api/kanban/list/create

HTTP request method:

  • POST

request params:

  • name (form, required): list name

  • project_id (form, required): project ID

  • after_id (form, optional): list ID to place after it when sorting

  • before_id (form, optional): list ID to place before it when sorting

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/list/create" -d "name=待办&project_id=1"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}

move kanban list

interface address:

  • /api/kanban/list/move

HTTP request method:

  • POST

request params:

  • id (form, required): list ID

  • after_id (form, optional): list ID to place after it when moving

  • before_id (form, optional): list ID to place before it when moving

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/list/move"

response example：

  • JSON:

    {
}

update kanban list

interface address:

  • /api/kanban/list/update

HTTP request method:

  • POST

request params:

  • id (form, required): list ID

  • name (form, optional): name

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/list/update" -d "id=1&name=新名称"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

delete kanban list

interface address:

  • /api/kanban/list/delete

HTTP request method:

  • POST

request params:

  • id (form, required): list ID

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/list/delete"

response example：

  • JSON:

    {
}

get kanban card list

interface address:

  • /api/kanban/card/list

HTTP request method:

  • GET

request params:

  • project_id (query, required): project ID

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/kanban/card/list"

response example：

  • JSON:

    {
}

create kanban card

interface address:

  • /api/kanban/card/create

HTTP request method:

  • POST

request params:

  • title (form, required): card title

  • list_id (form, required): list ID

  • color (form, optional): color

  • due (form, optional): due time

  • principal_id (form, optional): assignee ID

  • after_id (form, optional): card ID to place after it when sorting

  • before_id (form, optional): card ID to place before it when sorting

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/card/create" -d "title=任务&list_id=1"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}

get kanban card detail

interface address:

  • /api/kanban/card/detail/:id

HTTP request method:

  • GET

request params:

  • id (path): card ID

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/kanban/card/detail/:id"

response example：

  • JSON:

    {
}

move kanban card

interface address:

  • /api/kanban/card/move

HTTP request method:

  • POST

request params:

  • id (form, required): card ID

  • list_id (form, required): target list ID

  • after_id (form, optional): card ID to place after it when moving

  • before_id (form, optional): card ID to place before it when moving

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/card/move"

response example：

  • JSON:

    {
}

update kanban card

interface address:

  • /api/kanban/card/update

HTTP request method:

  • POST

request params:

  • id (form, required): card ID

  • title (form, optional): title

  • desc (form, optional): description

  • color (form, optional): color

  • due (form, optional): due time

  • principal_id (form, optional): assignee ID

  • status (form, optional): status

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/card/update"

response example：

  • JSON:

    {
}

delete kanban card

interface address:

  • /api/kanban/card/delete

HTTP request method:

  • POST

request params:

  • id (form, required): card ID

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/kanban/card/delete" -d "id=1"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

get kanban card assigned

interface address:

  • /api/kanban/card/assigned

HTTP request method:

  • GET

request params:

  • See the implementation (e.g. cards assigned to me)

response code:

  • common response

kanban project stream

interface address:

  • /api/kanban/stream/:id

HTTP request method:

  • GET

request params:

  • id (path): project ID

response code:

  • SSE stream, Content-Type: text/event-stream