SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceChecklist Items

Returns the checklist items for a private task with the specified id.

GET
https://api.awork.com/api/v1/users/:userId/otherprivatetasks/:taskId/checklistitems
GET
/api/v1/users/:userId/otherprivatetasks/:taskId/checklistitems
1curl https://api.awork.com/api/v1/users/userId/otherprivatetasks/taskId/checklistitems \
2 -H "Authorization: Bearer <token>"
Try it
200Retrieved
1[
2 {
3 "isDone": true,
4 "name": "Create YouTube Ads",
5 "order": 4,
6 "id": "123e4567-e89b-12d3-a456-426614174000",
7 "createdOn": "2021-03-12T11:00:00Z",
8 "createdBy": "123e4567-e89b-12d3-a456-426614174000",
9 "updatedOn": "2021-03-14T11:31:00Z",
10 "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
11 "taskId": "123e4567-e89b-12d3-a456-426614174000"
12 }
13]
The user needs to be the creator of the task. <Check title="Required Permissions">Any authenticated user.</Check>
Was this page helpful?
Previous

Returns the checklist for a private task with the specified id.

Next
Built with
Returns the checklist for a private task with the specified id.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

userIdstringRequiredformat: "uuid"
The id of the user. Not required when using the /me route.
taskIdstringRequiredformat: "uuid"
The id of the task.

Response

OK
isDoneboolean or null
Whether the checklist item is done.
namestring or null
The name of the checklist item.
orderdouble or null
The order of the checklist item.
idstring or nullformat: "uuid"
The id of the checklist item.
createdOnstring or nullformat: "date-time"
The date this checklist item was created.
createdBystring or nullformat: "uuid"
The id of the user who created this checklist item.
updatedOnstring or nullformat: "date-time"
The date this checklist item was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this checklist item.
taskIdstring or nullformat: "uuid"
The id of the task this checklist item belongs to.
The id of the task.
OK

The id of the user. Not required when using the /me route.

The user needs to be the creator of the task.

Required Permissions
Any authenticated user.

Bearer authentication of the form Bearer <token>, where token is your auth token.