---
title: "Get a task checklist"
method: GET
path: "/tasks/{id}/checklist"
tags: ["Tasks"]
---

# Get a task checklist

`GET /tasks/{id}/checklist`

## Request

- Base URL: `https://app.pencil.ink/api/v1`
- URL: `https://app.pencil.ink/api/v1/tasks/{id}/checklist`
- Auth: HTTP bearer

## Response `200`

A task checklist.

- object
  - `data` TaskChecklist
    - `taskId` string
    - `readOnly` boolean
    - `summary` TaskChecklistSummary
      - `subjectCount` integer
      - `stepCount` integer
      - `total` integer
      - `completed` integer
      - `requiredTotal` integer
      - `requiredCompleted` integer
      - `incompleteRequired` integer
      - `complete` boolean
      - `percent` integer
    - `steps` object[]
      - `_id` string
      - `title` string
      - `required` boolean
      - `position` integer
    - `subjects` object[]
      - `_id` string
      - `name` string
      - `email` string, nullable
      - `linkedUserId` string, nullable
      - `position` integer
      - `summary` TaskChecklistSummary
        - `subjectCount` integer
        - `stepCount` integer
        - `total` integer
        - `completed` integer
        - `requiredTotal` integer
        - `requiredCompleted` integer
        - `incompleteRequired` integer
        - `complete` boolean
        - `percent` integer
      - `items` TaskChecklistItem[]
        - `stepId` string
        - `subjectId` string, nullable
        - `title` string
        - `required` boolean
        - `position` integer
        - `completed` boolean
    - `items` TaskChecklistItem[]: Plain checklist items when no subjects are present.
      - `stepId` string
      - `subjectId` string, nullable
      - `title` string
      - `required` boolean
      - `position` integer
      - `completed` boolean

## Other responses

- `401`: Missing or invalid API key (`unauthorized`).
- `404`: Resource not found in this org (`not_found`).

---

[API](https://skmtc.dev/pencil/apis/pencil-public-api.md) · [All operations](https://skmtc.dev/pencil/apis/pencil-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pencil/apis/pencil-public-api/revisions/2b842698b76d?raw)