Tasks
Endpoints for retrieving task details, updating task status and assignments, adding comments, and updating control values.
Get Task Details
Returns full details for a specific task, including all control values, comments, and assignees.
GET /api/task/details
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 that contains the task. |
taskKey | string (GUID) | Yes | The key of the task. |
Example Request
GET https://app.checkflow.io/api/task/details?checklistId=1234&taskKey=07072bc4-f1eb-4536-819a-1ddb7dc109a1
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Returns the task with full details. |
401 | API key is missing or invalid. |
404 | Task not found. |
Get Task Assignments
Returns the assignment details for all tasks assigned to a specific team member or group.
GET /api/task/assignments
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assigneeId | int | Yes | — | The ID of the team member or group. |
assigneeType | int | Yes | — | 1 for team member, 2 for group. |
includeTeamMemberGroups | bool | No | false | When true, also returns tasks assigned to groups the team member belongs to. |
includeCompletedTasks | bool | No | false | When true, includes tasks that have already been completed. |
Example Request
GET https://app.checkflow.io/api/task/assignments?assigneeId=7&assigneeType=1&includeCompletedTasks=false
X-API-KEY: your-api-key-here
Response Codes
| Code | Description |
|---|---|
200 | Returns all task assignments for the assignee. |
401 | API key is missing or invalid. |
Update Task Status
Updates the status of a task (complete, incomplete, or not applicable).
note
This endpoint requires API version 2.0.
PUT /api/task/status
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
X-API-VERSION | Yes | Must be 2.0 |
Request Body
{
"taskId": 5678,
"status": "Complete",
"modifiedByUserID": 7
}
| Field | Type | Required | Description |
|---|---|---|---|
taskId | int | Yes | The ID of the task to update. |
status | string | Yes | The new status. Values: Complete, Incomplete, NotApplicable. |
modifiedByUserID | int | Yes | The ID of the user making the change. Use 0 for anonymous. |
Response Codes
| Code | Description |
|---|---|
200 | Returns the full task details after the status update. |
401 | API key is missing or invalid. |
404 | Task not found. |
Update Task Assignments
Replaces all assignees on a task with a new set of assignees.
note
This endpoint requires API version 2.0.
PUT /api/task/assignments
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
X-API-VERSION | Yes | Must be 2.0 |
Request Body
{
"taskId": 5678,
"assignees": [
{ "assigneeId": 7, "assigneeType": 1 },
{ "assigneeId": 3, "assigneeType": 2 }
],
"isAssignedExclusively": false
}
| Field | Type | Required | Description |
|---|---|---|---|
taskId | int | Yes | The ID of the task to update. |
assignees | array | Yes | List of assignees to set on the task. |
assignees[].assigneeId | int | Yes | The ID of the team member or group. |
assignees[].assigneeType | int | Yes | 1 for team member, 2 for group. |
isAssignedExclusively | bool | Yes | When true, the task is exclusively assigned to the given assignees. |
Response Codes
| Code | Description |
|---|---|
200 | Returns the full task details after the assignment update. |
401 | API key is missing or invalid. |
404 | Task not found. |
Add Task Assignees by Name
Assigns team members or groups to a task by looking up their names. Optionally removes existing assignees first.
note
This endpoint requires API version 2.0.
POST /api/task/assign-by-name
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
X-API-VERSION | Yes | Must be 2.0 |
Request Body
{
"taskId": 5678,
"assigneeNames": ["Jane Smith", "Operations Team"],
"isAssignedExclusively": false,
"deleteExistingAssignees": true
}
| Field | Type | Required | Description |
|---|---|---|---|
taskId | int | Yes | The ID of the task to update. |
assigneeNames | string[] | Yes | Names of the team members or groups to assign. |
isAssignedExclusively | bool | Yes | When true, the task is exclusively assigned to the given assignees. |
deleteExistingAssignees | bool | Yes | When true, all existing assignees are removed before adding the new ones. |
Response Codes
| Code | Description |
|---|---|
200 | Returns the full task details after the assignment. |
401 | API key is missing or invalid. |
404 | Task not found. |
Create Task Comment
Adds a comment to a task.
POST /api/task/comment
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Request Body
{
"taskId": 5678,
"commentHtml": "<p>Please review this before sign-off.</p>",
"createdByUserID": 7
}
| Field | Type | Required | Description |
|---|---|---|---|
taskId | int | Yes | The ID of the task to comment on. |
commentHtml | string | Yes | The comment content as an HTML string. |
createdByUserID | int | Yes | The ID of the user creating the comment. Use 0 for anonymous. |
Response Codes
| Code | Description |
|---|---|
200 | Comment created successfully. |
400 | Comment could not be created. |
401 | API key is missing or invalid. |
404 | Task not found. |
Delete Task Assignments
Removes all assignees from a task.
note
This endpoint requires API version 2.0.
DELETE /api/task/assignments
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
X-API-VERSION | Yes | Must be 2.0 |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | int | Yes | The ID of the task. |
Example Request
DELETE https://app.checkflow.io/api/task/assignments?taskId=5678
X-API-KEY: your-api-key-here
X-API-VERSION: 2.0
Response Codes
| Code | Description |
|---|---|
200 | Returns the full task details after assignments are cleared. |
401 | API key is missing or invalid. |
404 | Task not found. |
Update Task Control Value
Updates the value of a control within a task (e.g. sets the value of a Short Text, Date, or Dropdown control).
PUT /api/task/update-task-content
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Request Body
{
"taskContentID": 99,
"contentID": 55,
"key": "4cb6f84c-950f-4424-aa7b-d12608419d9b",
"contentType": "ShortText",
"name": "Customer Name",
"value": "Acme Corp"
}
| Field | Type | Required | Description |
|---|---|---|---|
taskContentID | int | Yes | The ID of the task content record. |
contentID | int | Yes | The ID of the content control. |
key | string (GUID) | Yes | The key of the content control. |
contentType | string | Yes | The type of control. See supported values below. |
name | string | Yes | The label/name of the control. |
value | any | Yes | The value to set. Format depends on contentType. |
Supported Content Types
contentType | Description |
|---|---|
ShortText | Single line of text |
LongText | Multiple lines of text |
EmailInput | Email address |
Website | Website URL |
Date | Date, time, or date and time |
DropDown | Single selected item |
MultiChoice | One or more selected items |
SubTasks | Sub-task checklist |
Members | Selected team members or groups |
Table | Grid of cell values |
Text | Rich text content |
Image | Image |
Video | Video |
File | File |
Response Codes
| Code | Description |
|---|---|
200 | Control value updated successfully. |
400 | Control value could not be updated. |
401 | API key is missing or invalid. |
404 | Control not found. |