Checklists
Endpoints for creating, searching, and deleting checklists.
Find Checklists
Finds checklists matching the given search criteria. Optionally creates a new checklist if none are found.
GET /api/checklist/find
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateKey | string (GUID) | Yes | — | The key of the template the checklist is derived from. |
checklistName | string | No | — | Full or partial checklist name to search for. |
tag | string | No | — | Full or partial tag name to filter by. |
status | string | No | ALL | Checklist status filter. Values: ALL, SCHEDULED, INPROGRESS, RECENTLYCOMPLETE, COMPLETE. |
createIfNotExists | bool | No | false | If true and no checklists are found, a new checklist is created using checklistName. |
pageSize | int | No | 3 | Number of results per page. Maximum: 10. |
pageNumber | int | No | 1 | Page number. |
Example Request
GET https://app.checkflow.io/api/checklist/find?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb&status=INPROGRESS&pageSize=5
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Returns matching checklists. |
401 | API key is missing or invalid. |
404 | No checklists found matching the criteria. |
Get Checklist Details
Returns full details for checklists matching the search criteria, including all task and control data.
GET /api/checklist/details
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateKey | string (GUID) | Yes | — | The key of the template the checklist is derived from. |
checklistKey | string (GUID) | No | — | The key of a specific checklist. |
checklistName | string | No | — | Full or partial checklist name to search for. |
tag | string | No | — | Full or partial tag name to filter by. |
status | string | No | ALL | Checklist status filter. Values: ALL, SCHEDULED, INPROGRESS, RECENTLYCOMPLETE, COMPLETE. |
pageSize | int | No | 3 | Number of results per page. Maximum: 10. |
pageNumber | int | No | 1 | Page number. |
Example Request
GET https://app.checkflow.io/api/checklist/details?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb&checklistKey=27217bc9-1f00-460e-bf41-3821cd37beaf
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Returns matching checklists with full task and control data. |
401 | API key is missing or invalid. |
404 | No checklists found matching the criteria. |
Get Tasks by Task Key
Returns tasks across all checklists matching a specific template task key and status.
GET /api/checklist/tasks
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskKey | string (GUID) | Yes | — | The key of the task (from the template). |
status | string | No | ALL | Task status filter. Values: ALL, OPEN, COMPLETE. |
pageSize | int | No | 3 | Number of results per page. Maximum: 10. |
pageNumber | int | No | 1 | Page number. |
Example Request
GET https://app.checkflow.io/api/checklist/tasks?taskKey=07072bc4-f1eb-4536-819a-1ddb7dc109a1&status=OPEN
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Returns matching tasks. |
401 | API key is missing or invalid. |
404 | No tasks found matching the criteria. |
Get Uploaded Files
Returns all files uploaded via a File Upload control, identified by its control key.
GET /api/checklist/uploaded-files
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskContentKey | string (GUID) | Yes | — | The key of the File Upload control. |
pageSize | int | No | 3 | Number of results per page. Maximum: 10. |
pageNumber | int | No | 1 | Page number. |
Example Request
GET https://app.checkflow.io/api/checklist/uploaded-files?taskContentKey=50d58518-e049-4474-84c7-036236e52923
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Returns the File Upload control details and all uploaded files. |
401 | API key is missing or invalid. |
404 | No File Upload control found for the given key. |
Create Checklist
Creates a new checklist from a template.
POST /api/checklist
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
templateKey | string (GUID) | Yes | The key of the template to create the checklist from. |
checklistName | string | Yes | The name for the new checklist. |
Example Request
POST https://app.checkflow.io/api/checklist?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb&checklistName=Invoice%20Review%20-%20March
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Returns the newly created checklist. |
401 | API key is missing or invalid. |
Create Many Checklists
Creates multiple checklists from a single template in one request.
note
This endpoint requires API version 2.0.
POST /api/checklist/create-many
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
X-API-VERSION | Yes | Must be 2.0 |
Request Body
{
"templateKey": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb",
"checklistNames": [
"Invoice Review - March",
"Invoice Review - April",
"Invoice Review - May"
]
}
| Field | Type | Required | Description |
|---|---|---|---|
templateKey | string (GUID) | Yes | The key of the template to create checklists from. |
checklistNames | string[] | Yes | A list of names for the checklists to create. |
Response Codes
| Code | Description |
|---|---|
200 | Returns the list of newly created checklists. |
401 | API key is missing or invalid. |
Create Checklist with Parameters
Creates a new checklist and sets one or more parameter values at creation time.
note
This endpoint requires API version 2.0.
POST /api/checklist/create-with-parameters
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
X-API-VERSION | Yes | Must be 2.0 |
Request Body
{
"templateKey": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb",
"checklistName": "Invoice Review - March",
"parameters": [
{
"parameterName": "Client Name",
"parameterValue": "Acme Corp"
},
{
"parameterName": "Invoice Number",
"parameterValue": "INV-00123"
}
]
}
| Field | Type | Required | Description |
|---|---|---|---|
templateKey | string (GUID) | Yes | The key of the template to create the checklist from. |
checklistName | string | Yes | The name for the new checklist. |
parameters | array | No | A list of parameter name/value pairs to set. |
parameters[].parameterName | string | Yes | The name of the template parameter. |
parameters[].parameterValue | string | Yes | The value to assign to the parameter. |
Response Codes
| Code | Description |
|---|---|
200 | Returns the newly created checklist. |
401 | API key is missing or invalid. |
Share Checklist
Creates or removes a public share URL for a checklist.
POST /api/checklist/share
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
checklistId | int | Yes | The ID of the checklist. |
isShared | bool | Yes | true to create a share URL, false to remove it. |
Example Request
POST https://app.checkflow.io/api/checklist/share?checklistId=1234&isShared=true
X-API-KEY: your-api-key-here
Example Response
{
"isShared": true,
"shareUrl": "https://app.checkflow.io/shared/abc123"
}
Response Codes
| Code | Description |
|---|---|
200 | Returns the updated share status and URL. |
401 | API key is missing or invalid. |
Delete Checklist
Permanently deletes a checklist.
DELETE /api/checklist
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
checklistId | int | Yes | The ID of the checklist to delete. |
Example Request
DELETE https://app.checkflow.io/api/checklist?checklistId=1234
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Checklist deleted successfully. |
401 | API key is missing or invalid. |
404 | Checklist not found. |
Delete Many Checklists
Deletes multiple checklists in a single request. Checklists can be targeted by ID or by template key and status.
DELETE /api/checklist/delete-many
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Request Body
{
"checklistIds": [1001, 1002, 1003],
"templateKeys": [],
"checklistStatus": "ALL"
}
| Field | Type | Required | Description |
|---|---|---|---|
checklistIds | int[] | No | A list of specific checklist IDs to delete. |
templateKeys | string[] (GUIDs) | No | A list of template keys. All checklists from these templates matching checklistStatus will be deleted. |
checklistStatus | string | No | Status filter when using templateKeys. Values: ALL, INPROGRESS, COMPLETE, SCHEDULED. |
Response Codes
| Code | Description |
|---|---|
200 | Checklists deleted successfully. |
401 | API key is missing or invalid. |