Skip to main content

List all subtask lists

Returns a list of subtask lists for a task. The lists are returned sorted by creation date, with the most recently created appearing first.

Parameters​

expand
array
Array of relationships to expand. Supported values: task, subtasks. When expanding subtasks, each subtask supports: members, parent.

Returns​

Returns a paginated response that contains an array of up to the specified limit of subtask lists.

get
/api/tasks/{id}/subtask-lists
curl https://{workspace}.kitchen.co/api/tasks/{id}/subtask-lists \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "data": [
    {
      "id": "tskl_9bbcb52099a37312fbff58c8",
      "name": "Checklist name",
      "task": "tsk_9bbcb52099a37312fbff58c8",
      "subtasks": [
        "tsk_9f82b648c61222c4086850c2"
      ],
      "createdAt": "2024-03-21T07:52:35+00:00",
      "updatedAt": "2024-03-21T07:52:35+00:00"
    }
  ],
  "links": {
    "first": "/api/tasks/tsk_9bbcb52099a37312fbff58c8/subtask-lists?page=1",
    "last": "/api/tasks/tsk_9bbcb52099a37312fbff58c8/subtask-lists?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "/api/tasks/tsk_9bbcb52099a37312fbff58c8/subtask-lists?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "/api/tasks/tsk_9bbcb52099a37312fbff58c8/subtask-lists",
    "per_page": 20,
    "to": 1,
    "total": 1
  }
}