---
title: "Get a checklist"
method: GET
path: "/checklists/{checklist_id}.{format}"
tags: ["Checklists"]
---

# Get a checklist

`GET /checklists/{checklist_id}.{format}`

With `json` or `xml` returns the list representation. This URL also exports the
whole list as a document — `opml`, `md` or `txt` — controlled by the `export_*`
parameters below.

OPML is the full-fidelity format: it keeps the whole tree with notes, tags, due
dates, assignees, priority/color and open/closed status, and can be fed back to
the import call. Pass `export_id=true` to add each item's task ID as the `id`
attribute of its `<outline>` element — the way to get task IDs out of an export
(they are ignored on re-import, imported items get new IDs), for example
`/checklists/182531.opml?export_id=true`.

## Path parameters

- `checklist_id` integer, required
- `format` 'json' | 'xml' | 'opml' | 'md' | 'txt', required

## Query parameters

- `with_inbound_email` boolean
- `export_id` boolean
- `export_notes` boolean
- `export_status` boolean
- `export_color` boolean
- `max_heading` integer

## Response `200`

The requested checklist in corresponding format.

- Checklist
  - `id` integer
  - `name` string
  - `public` boolean — True for a checklist that anyone can read without authentication.
  - `role` 1 | 2 | 3 — 1 - author, 2 - writer, 3 - reader.
  - `updated_at` string — Time of the last update (includes task updates, excludes comments). See **Timestamp format** in the introduction.
  - `task_count` integer — Total number of leaf tasks.
  - `task_completed` integer — Number of completed leaf tasks.
  - `read_only` boolean — True if the user's access to this list is read-only.
  - `archived` boolean — True if the user archived this list.
  - `inbound_email` string — The list's inbound "email to list" address (send mail here to add tasks to the list; the same address shown in the web UI). The address embeds the user's Remote API key, so regenerating that key changes the `inbound_email` of every list.
  - `tags` object — (JSON only) Map of tag name => isPrivate.
  - `tags_as_text` string — (JSON only) Comma-separated list of tag names.

## Changes

- **2026-08-15** `46c581a89dd5` — 11 info
  - added the new optional `query` request parameter `export_color`
  - added the new optional `query` request parameter `export_id`
  - added the new optional `query` request parameter `export_notes`
  - added the new optional `query` request parameter `export_status`
  - …7 more

[Change history](https://skmtc.dev/checkvist/apis/checkvist-open-api/changes/checklists/:checklist_id.:format/get.md)

---

[API](https://skmtc.dev/checkvist/apis/checkvist-open-api.md) · [All operations](https://skmtc.dev/checkvist/apis/checkvist-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/checkvist/checkvist-open-api/revisions/53311ff6aaab/schema)