Get the List of Checklist Items task.checklistitem.getlist
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
taskWho can execute the method: any user with read access permission to the task or higher.
The method task.checklistitem.getlist retrieves a list of checklist items in a task.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
TASKID* |
Identifier of the task. The identifier can be obtained when creating a task or by using the get task list method |
|
ORDER |
An object for sorting the result in the form You can sort by the following fields:
The sort direction can take the following values:
By default, the result is sorted by |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ORDER":{"IS_COMPLETE":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.checklistitem.getlist
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ORDER":{"IS_COMPLETE":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.checklistitem.getlist
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ChecklistItem = {
ID: string
TASK_ID: string
PARENT_ID: string
CREATED_BY: string
TITLE: string
SORT_INDEX: string
IS_COMPLETE: 'Y' | 'N'
IS_IMPORTANT: 'Y' | 'N'
TOGGLED_BY: string | null
TOGGLED_DATE: ISODate | null
MEMBERS: Array<{
ID: string
TYPE: string
NAME: string
PERSONAL_PHOTO: string
PERSONAL_GENDER: string
IMAGE: string
IS_COLLABER: boolean
}>
ATTACHMENTS: Record<string, {
ATTACHMENT_ID: number
NAME: string
SIZE: string
FILE_ID: string
DOWNLOAD_URL: string
VIEW_URL: string
}>
}
try {
// task.checklistitem.getlist returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<ChecklistItem[]>({
method: 'task.checklistitem.getlist',
params: {
TASKID: 8017,
ORDER: {
IS_COMPLETE: 'ASC',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Checklist items count:', result.length, 'First item:', result[0]?.ID, result[0]?.TITLE)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getChecklistItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// task.checklistitem.getlist returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'task.checklistitem.getlist',
params: {
TASKID: 8017,
ORDER: {
IS_COMPLETE: 'ASC',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Checklist items count:', result.length, 'First item:', result[0]?.ID, result[0]?.TITLE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getChecklistItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"IS_COMPLETE": "ASC",
}
try:
bitrix_response = client.task.checklistitem.getlist(
task_id=8017,
order=order,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'task.checklistitem.getlist',
[
'TASKID' => 8017,
'ORDER' => [
'IS_COMPLETE' => 'ASC'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching checklist items: ' . $e->getMessage();
}
BX24.callMethod(
'task.checklistitem.getlist',
{
'TASKID': 8017,
'ORDER': {
'IS_COMPLETE': 'ASC'
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.checklistitem.getlist',
[
'TASKID' => 8017,
'ORDER' => [
'IS_COMPLETE' => 'ASC'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "task.checklistitem.getlist", b24.Params{
"TASKID": 8017,
"ORDER": b24.Params{
"IS_COMPLETE": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("task.checklistitem.getlist: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
TaskID b24.ID `json:"TASK_ID"`
ParentID b24.ID `json:"PARENT_ID"`
CreatedBy string `json:"CREATED_BY"`
Title string `json:"TITLE"`
SortIndex string `json:"SORT_INDEX"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.TaskID)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"ID": "477",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Prepare contract Sarah Johnson",
"SORT_INDEX": "2",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:30+02:00",
"MEMBERS": [
{
"ID": "103",
"TYPE": "A",
"NAME": "Sarah Johnson",
"PERSONAL_PHOTO": "8644",
"PERSONAL_GENDER": "F",
"IMAGE": "https://mysite.com/b17053/resize_cache/8644/c0120a8d7c10d63c83e32398d1ec4d9e/main/45f/45fff10d17d398a5583184c8350cd197/buh.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": {
"1113": {
"ATTACHMENT_ID": 1113,
"NAME": "Instructions.docx",
"SIZE": "115161",
"FILE_ID": "5065",
"DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1113&action=download&ncc=1",
"VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1113&action=show&ncc=1"
},
"1115": {
"ATTACHMENT_ID": 1115,
"NAME": "Document List.xlsx",
"SIZE": "14675",
"FILE_ID": "5067",
"DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1115&action=download&ncc=1",
"VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1115&action=show&ncc=1"
}
}
},
{
"ID": "431",
"TASK_ID": "8017",
"PARENT_ID": 0,
"CREATED_BY": "503",
"TITLE": "Checklist 1",
"SORT_INDEX": "0",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "447",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Agree on details with the client",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "469",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Agree with the manager Andrew Smith John Doe",
"SORT_INDEX": "2",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [
{
"ID": "3",
"TYPE": "A",
"NAME": "Andrew Smith",
"PERSONAL_PHOTO": "249",
"PERSONAL_GENDER": "M",
"IMAGE": "https://mysite.com/b17053/resize_cache/249/c0120a8d7c10d63c83e32398d1ec4d9e/main/cd526b0644e7ff4d794ea41cb36bc423/odmin.png",
"IS_COLLABER": false
},
{
"ID": "11",
"TYPE": "U",
"NAME": "John Doe",
"PERSONAL_PHOTO": "231",
"PERSONAL_GENDER": "",
"IMAGE": "https://mysite.com/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": []
},
{
"ID": "471",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Prepare solution",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "491",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Sign contract",
"SORT_INDEX": "3",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "433",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Find all documents for the client",
"SORT_INDEX": "0",
"IS_COMPLETE": "Y",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:30+02:00",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "485",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Arrange a meeting John Doe",
"SORT_INDEX": "0",
"IS_COMPLETE": "Y",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:33+02:00",
"MEMBERS": [
{
"ID": "11",
"TYPE": "U",
"NAME": "John Doe",
"PERSONAL_PHOTO": "231",
"PERSONAL_GENDER": "",
"IMAGE": "https://mysite.com/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": []
}
],
"time": {
"start": 1762780903,
"finish": 1762780903.978847,
"duration": 0.9788470268249512,
"processing": 0,
"date_start": "2025-11-10T16:21:43+02:00",
"date_finish": "2025-11-10T16:21:43+02:00",
"operating_reset_at": 1762781503,
"operating": 0.3446669578552246
}
}
Returned Data
|
Name |
Description |
|
result |
A list of objects with description of checklist item fields |
|
time |
Information about the request execution time |
Fields of the result object
|
Name |
Description |
|
ID |
Identifier of the checklist item |
|
TASK_ID |
Identifier of the task to which the item belongs |
|
PARENT_ID |
Identifier of the parent item. A value of |
|
CREATED_BY |
Identifier of the item author |
|
TITLE |
Text of the checklist item. If |
|
SORT_INDEX |
Sort index. The smaller the value, the higher the item in the list or sublist |
|
IS_COMPLETE |
Completion status of the item. Possible values:
|
|
IS_IMPORTANT |
Importance mark of the item. Possible values:
|
|
TOGGLED_BY |
Identifier of the user who last changed the item's status. Can be |
|
TOGGLED_DATE |
Date and time of the item's status change in |
|
MEMBERS |
A list of objects with description of participants |
|
ATTACHMENTS |
An object with description of attached files. The key is the identifier of the attached file |
Members Object
|
Name |
Description |
|
ID |
Identifier of the user |
|
TYPE |
User's role in the checklist item. Possible values:
|
|
NAME |
User's name |
|
PERSONAL_PHOTO |
Identifier of the user's avatar file on Drive |
|
PERSONAL_GENDER |
User's gender. Possible values:
|
|
IMAGE |
Link to the user's avatar |
|
IS_COLLABER |
Indicates that the user is an external participant |
Attachments Object
|
Name |
Description |
|
ATTACHMENT_ID |
Identifier of the attachment |
|
NAME |
File name |
|
SIZE |
File size in bytes |
|
FILE_ID |
Identifier of the file on Drive |
|
DOWNLOAD_URL |
Link to download the file |
|
VIEW_URL |
Link to view the file in the browser |
Error Handling
HTTP Status: 400
{
"error":"ERROR_CORE",
"error_description":"TASKS_ERROR_EXCEPTION_#8; Action failed; 8\/TE\/ACTION_FAILED_TO_BE_PROCESSED\u003Cbr\u003E"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
TASKS_ERROR_EXCEPTION_#8; Action failed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED\u003Cbr\u003E |
User does not have access to the task |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskchecklistitem::getlist() expected to be of type \u0022integer\u0022, but given something else.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E |
Required parameter |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #1 (arOrder) for method ctaskchecklistitem::getlist() must not contain key \u0022IS_COMPLETED\u0022.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E |
An invalid field was specified in |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Checklists: Overview of Methods
- Add Checklist Item with task.checklistitem.add
- Update Checklist Item with task.checklistitem.update
- Get Checklist Item task.checklistitem.get
- Delete Checklist Item in task.checklistitem.delete
- Move Checklist Item with task.checklistitem.moveafteritem
- Mark a checklist item as completed task.checklistitem.complete
- Mark a checklist item as incomplete task.checklistitem.renew
- Check Action Permission for task.checklistitem.isactionallowed