Checklist

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

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

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

Query parameters

templateKeystring

The key for the template the checklist is derived from

checklistKeystring

The key for the checklist

checklistNamestring

The name of the checklist (can be a partial checklist name)

tagstring

The tag associated with the checklist (can be a partial tag name)

statusstring

The status of the checklists to be returned. Can be one of the following values: ALL, SCHEDULED, INPROGRESS, RECENTLYCOMPLETE, COMPLETE

pageSizeinteger

Page size. Maximum of 10.

pageNumberinteger

Page number

Headers

X-API-VERSIONstring

The requested API version

X-API-KEYunknown

API Key

Response

Returns the matching checklists

Changes

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