Skip to content

totask List API Documentation

List Routes

All list-related endpoints are prefixed with /list.

Create List

Endpoint: POST /list/create

Description: Creates a new list.

Request Body:

json
{
  "name": "List Name",
  "board": "board_id"
}

Response:

  • 201 Created

Get list by Board

Endpoint: GET /list/listsOf/:boardId

Description: Retrieves list by board ID.

Response:

  • 200 OK
    json
    {
      "results": [ ... ],
      "page": 1,
      "limit": 10,
      "totalPages": 1,
      "totalResults": 1
    }

Get List by ID

Endpoint: GET /list/:listId

Description: Retrieves a list by ID.

Response:

  • 200 OK
    json
    {
      "_id": "list_id",
      "name": "List Name",
      ...
    }

Update List by ID

Endpoint: PUT /list/:listId

Description: Updates a list by ID.

Request Body:

json
{
  "name": "New List Name"
}

Response:

  • 200 OK
    json
    {
      "_id": "list_id",
      "name": "New List Name",
      ...
    }

Delete List by ID

Endpoint: DELETE /list/:listId

Description: Deletes a list by ID.

Response:

  • 200 OK .