Get the List of Checklist Items for Task Template tasks.template.checklist.list
Scope:
taskWho can execute the method: user with read access permission for the task template
The method tasks.template.checklist.list returns a list of checklist items for a task template.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
templateId* |
Identifier of the task template. The identifier of the task template can be obtained when creating a new template |
|
filter |
Filter for selecting checklist items in the form You can filter by the following fields:
The |
|
select |
List of fields to select. You can specify the following fields in the selection:
|
|
order |
Object for sorting the result in the form You can sort by the following fields:
The sorting 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 '{
"templateId": 139,
"filter": {
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N"
},
"select": [
"ID",
"TEMPLATE_ID",
"PARENT_ID",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT"
],
"order": {
"SORT_INDEX": "asc",
"ID": "desc"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"filter": {
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N"
},
"select": [
"ID",
"TEMPLATE_ID",
"PARENT_ID",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT"
],
"order": {
"SORT_INDEX": "asc",
"ID": "desc"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.checklist.list
// callListMethod: Retrieves all data at once.
// Use only for small selections (< 1000 items) due to high
// memory load.
try {
const response = await $b24.callListMethod(
'tasks.template.checklist.list',
{
templateId: 139,
filter: {
IS_COMPLETE: 'N',
IS_IMPORTANT: 'N'
},
select: [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT'
],
order: {
SORT_INDEX: 'asc',
ID: 'desc'
}
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Selects data in parts using an iterator.
// Use for large volumes of data for efficient memory consumption.
try {
const generator = $b24.fetchListMethod('tasks.template.checklist.list', {
templateId: 139,
filter: {
IS_COMPLETE: 'N',
IS_IMPORTANT: 'N'
},
select: [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT'
],
order: {
SORT_INDEX: 'asc',
ID: 'desc'
}
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Manual control of pagination through the start parameter.
// Use for precise control over request batches.
// Less efficient for large data than fetchListMethod.
try {
const response = await $b24.callMethod('tasks.template.checklist.list', {
templateId: 139,
filter: {
IS_COMPLETE: 'N',
IS_IMPORTANT: 'N'
},
select: [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT'
],
order: {
SORT_INDEX: 'asc',
ID: 'desc'
}
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'tasks.template.checklist.list',
[
'templateId' => 139,
'filter' => [
'IS_COMPLETE' => 'N',
'IS_IMPORTANT' => 'N',
],
'select' => [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT',
],
'order' => [
'SORT_INDEX' => 'asc',
'ID' => 'desc',
]
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'tasks.template.checklist.list',
{
templateId: 139,
filter: {
IS_COMPLETE: 'N',
IS_IMPORTANT: 'N'
},
select: [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT'
],
order: {
SORT_INDEX: 'asc',
ID: 'desc'
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.template.checklist.list',
[
'templateId' => 139,
'filter' => [
'IS_COMPLETE' => 'N',
'IS_IMPORTANT' => 'N',
],
'select' => [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT',
],
'order' => [
'SORT_INDEX' => 'asc',
'ID' => 'desc',
]
]
);
print_r($result);
Response Handling
HTTP Status: 200
{
"result": {
"checkListItems": {
"23": {
"id": "23",
"templateId": "139",
"parentId": 0,
"title": "What needs to be done",
"sortIndex": "0",
"isComplete": "N",
"isImportant": "N"
},
"27": {
"id": "27",
"templateId": "139",
"parentId": "23",
"title": "2. Fill out the report form",
"sortIndex": "1",
"isComplete": "N",
"isImportant": "N"
},
"29": {
"id": "29",
"templateId": "139",
"parentId": "23",
"title": "3. Send the report to the manager",
"sortIndex": "3",
"isComplete": "N",
"isImportant": "N"
},
"25": {
"id": "25",
"templateId": "139",
"parentId": "23",
"title": "1. Gather data",
"sortIndex": "4",
"isComplete": "N",
"isImportant": "N"
}
}
},
"time": {
"start": 1773316805,
"finish": 1773316806.016895,
"duration": 1.016895055770874,
"processing": 0,
"date_start": "2026-03-12T15:00:05+01:00",
"date_finish": "2026-03-12T15:00:06+01:00",
"operating_reset_at": 1773317406,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the response data (detailed description) |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
checkListItems |
Object where the key is the identifier of the checklist item and the value is the description of the checklist item (detailed description). The set of fields in the response depends on the |
Object checkListItem
|
Name |
Description |
|
id |
Identifier of the checklist item |
|
copiedId |
Identifier of the original item when copied, if applicable |
|
userId |
Identifier of the user in the context of which the object was created |
|
createdBy |
Identifier of the item creator |
|
parentId |
Identifier of the parent item. A value of |
|
title |
Text of the checklist item |
|
sortIndex |
Sorting index. The lower the value, the higher the item appears in the list or sublist |
|
displaySortIndex |
Auxiliary value for display order |
|
isComplete |
Status of item completion |
|
isImportant |
Importance flag for the item |
|
completedCount |
Number of completions for the item |
|
members |
Array of objects with description of participants. If there is no data, an empty array |
|
attachments |
Object with description of attachments. If there is no data, an empty array |
|
nodeId |
Service identifier of the node, if used |
|
templateId |
Identifier of the task template |
Object members
|
Name |
Description |
|
id |
Identifier of the user |
|
type |
User's role in the checklist item. Possible values:
|
|
name |
User's name |
|
personalPhoto |
Identifier of the user's avatar file on Drive |
|
personalGender |
User's gender. Possible values:
|
|
image |
Link to the user's avatar |
|
isCollaber |
Indicator that the user is an external participant |
Object attachments
|
Name |
Description |
|
Identifier of the file on Drive in the format |
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Access to the task template is denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access to the task template is denied |
Insufficient rights to read the template |
|
|
|
Could not find value for parameter |
Required parameter |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Checklist Item to Task Template tasks.template.checklist.add
- Update Checklist Item of Task Template tasks.template.checklist.update
- Get Checklist Item of Task Template tasks.template.checklist.get
- Delete Checklist Item from Task Template tasks.template.checklist.delete
- Move Checklist Item After Another tasks.template.checklist.moveAfter
- Move Checklist Item Before Another Item: `tasks.template.checklist.moveBefore`
- Complete Checklist Item of Task Template tasks.template.checklist.complete
- Renew Checklist Item of Task Template tasks.template.checklist.renew
- Add Attachment to Checklist Item Using tasks.template.checklist.addAttachmentByContent
- Add Attachments from Drive to Checklist Item tasks.template.checklist.addAttachmentsFromDisk
- Remove Attachments from Checklist Item tasks.template.checklist.removeAttachments