Sign in
Task Lists

Create task list

Creates a task list within a card. Requires board editor permissions.

post/cards/{cardId}/task-lists

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/cards/{cardId}/task-lists
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

cardIdstring required
Example:1357158568008091264

ID of the card to create task list in

Request body

positionnumber required

Position of the task list within the card

namestring required

Name/title of the task list

showOnFrontOfCardboolean

Whether to show the task list on the front of the card

hideCompletedTasksboolean

Whether to hide completed tasks

Example request

{
  "position": 65536,
  "name": "Development Tasks",
  "showOnFrontOfCard": true
}

Response

Task list created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "cardId": "1357158568008091265",
    "position": 65536,
    "name": "Development Tasks",
    "showOnFrontOfCard": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.