Skip to content

totask Checklist API Documentation

Checklist Routes

All checklist-related endpoints are prefixed with /checklist.

Add Checklist Item

Endpoint: POST /checklist/item/:checklistId

Description: Adds a new item to a checklist.

Request Body:

json
{
  "name": "Item Name",
  "completed": false
}

Response:

  • 200 OK
    json
    {
      "_id": "checklist_id",
      "name": "Checklist Name",
      ...
    }

Update Checklist Item

Endpoint: PUT /checklist/item/:checklistItemId

Description: Updates an item in a checklist.

Request Body:

json
{
  "name": "Updated Item Name",
  "completed": true
}

Response:

  • 200 OK
    json
    {
      "_id": "checklist_id",
      "name": "Checklist Name",
      ...
    }

Delete Checklist Item

Endpoint: DELETE /checklist/item/:checklistItemId

Description: Deletes an item from a checklist.

Response:

  • 200 OK
    json
    {
      "_id": "checklist_id",
      "name": "Checklist Name",
      ...
    }

Delete Checklist

Endpoint: DELETE /checklist/:checklistId

Description: Deletes a checklist.

Response:

  • 200 OK
    json
    {
      "_id": "checklist_id",
      "name": "Checklist Name",
      ...
    }

Update Checklist

Endpoint: PUT /checklist/:checklistId

Description: Updates a checklist.

Request Body:

json
{
  "name": "Updated Checklist Name"
}

Response:

  • 200 OK
    json
    {
      "_id": "checklist_id",
      "name": "Updated Checklist Name",
      ...
    }
    .