---
title: "Gets full details for checklists matching the search criteria. This includes all task and content data. Either templateKey or checklistKey must be provided."
method: GET
path: "/api/checklist/details"
tags: ["Checklist"]
---

# Gets full details for checklists matching the search criteria. This includes all task and content data. Either templateKey or checklistKey must be provided.

`GET /api/checklist/details`

## Request

- Base URL: `https://app.checkflow.io` (the document declares no server; this is the origin it was published from)
- URL: `https://app.checkflow.io/api/checklist/details`
- Auth: none declared

If you do not know the key for the template your checklists are derived from use - GET: api/template/templates
            
Sample request:
            
    GET: api/checklist/details?checklistKey=1abcd949-d0c8-43dd-b643-917207f397d8
    GET: api/checklist/details?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb
    GET: api/checklist/details?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb&checklistName=My%20Checklist
    GET: api/checklist/details?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb&tag=Urgent
    GET: api/checklist/details?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb&status=INPROGRESS

## Query parameters

- `templateKey` string
- `checklistKey` string
- `checklistName` string
- `tag` string
- `status` string
- `pageSize` integer
- `pageNumber` integer

## Headers

- `X-API-VERSION` string
- `X-API-KEY` unknown

## Response `200`

Returns the matching checklists

## Other responses

- `401`: If the API Key could not be validated
- `404`: If no checklists are found

---

[API](https://skmtc.dev/checkflow/apis/checkflow-api.md) · [All operations](https://skmtc.dev/checkflow/apis/checkflow-api/llms.txt) · [OpenAPI document](https://skmtc.dev/checkflow/apis/checkflow-api/revisions/4004b1f66432?raw)