Get the List of Checklist Items for Task Template tasks.template.checklist.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: a user with read access permission for the task template
The method tasks.template.checklist.list returns a list of checklist items for the 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
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CheckListItem = {
id: string
templateId: string
parentId: number | string
title: string
sortIndex: string
isComplete: string
isImportant: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type CheckListItemsResult = {
checkListItems: Record<string, CheckListItem>
}
try {
// tasks.template.checklist.list 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<CheckListItemsResult>({
method: 'tasks.template.checklist.list',
params: {
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',
},
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:', Object.keys(result.checkListItems).length,
'Items:', result.checkListItems
)
}
} 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 listTemplateChecklistItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// tasks.template.checklist.list 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: 'tasks.template.checklist.list',
params: {
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',
},
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:', Object.keys(result.checkListItems).length,
'Items:', result.checkListItems
)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listTemplateChecklistItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.template.checklist.list(
template_id=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",
},
).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(
'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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "tasks.template.checklist.list", b24.Params{
"templateId": 139,
"filter": b24.Params{
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
},
"select": []string{"ID", "TEMPLATE_ID", "PARENT_ID", "TITLE", "SORT_INDEX", "IS_COMPLETE", "IS_IMPORTANT"},
"order": b24.Params{
"SORT_INDEX": "asc",
"ID": "desc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.template.checklist.list: %w", err)
}
// The method wraps the response in an object with the "checkListItems" key.
raw, ok := b24.Unwrap(res.Result, "checkListItems")
if !ok {
return fmt.Errorf("no checkListItems key in the response")
}
fmt.Printf("%s\n", raw)
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 |
Object result
|
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 is 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 in the list or sublist |
|
displaySortIndex |
Auxiliary value for display order |
|
isComplete |
Status of the item completion |
|
isImportant |
Importance flag of the item |
|
completedCount |
Number of completions of 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 |
Role of the user in the checklist item. Possible values:
|
|
name |
User's name |
|
personalPhoto |
Identifier of the user's avatar file on Drive |
|
personalGender |
Gender of the user. Possible values:
|
|
image |
Link to the user's avatar |
|
isCollaber |
Indicator that the user is an external participant |
Object attachments
|
Name |
Description |
|
attachmentId |
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 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
|
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: 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 |
|
|
|
The REST API is available only on commercial plans. 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
- Add Checklist Item to Task Template tasks.template.checklist.add
- Update Checklist Item of Task Template tasks.template.checklist.update
- Get Checklist Item from 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 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