Get Checklist Item task.checklistitem.get
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 for the task or higher.
The method task.checklistitem.get retrieves the description of a checklist item by its identifier.
Method Parameters
Pass parameters in the request according to the order in the table. If the order is violated, the request will return an error.
Required parameters are marked with *
|
Name |
Description |
|
TASKID* |
Task identifier. The identifier can be obtained when creating a task or by using the get task list method |
|
ITEMID* |
Checklist item identifier. The item identifier can be obtained when adding a new item or by using the get checklist item list method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ITEMID":479}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.checklistitem.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ITEMID":479,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.checklistitem.get
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type ChecklistItemResult = {
ID: string
TASK_ID: string
PARENT_ID: string
CREATED_BY: string
TITLE: string
SORT_INDEX: string
IS_COMPLETE: string
IS_IMPORTANT: string
TOGGLED_BY: string | null
TOGGLED_DATE: string
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 {
const response = await $b24.actions.v2.call.make<ChecklistItemResult>({
method: 'task.checklistitem.get',
params: {
TASKID: 8017,
ITEMID: 479,
},
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 item:', result.ID, result.TITLE, 'complete:', result.IS_COMPLETE)
}
} 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 getChecklistItem() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.checklistitem.get',
params: {
TASKID: 8017,
ITEMID: 479,
},
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 item:', result.ID, result.TITLE, 'complete:', result.IS_COMPLETE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getChecklistItem)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.task.checklistitem.get(
task_id=8017,
item_id=479,
).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.get',
[
'TASKID' => 8017,
'ITEMID' => 479
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error retrieving checklist item: ' . $e->getMessage();
}
BX24.callMethod(
'task.checklistitem.get',
{
TASKID: 8017,
ITEMID: 479
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.checklistitem.get',
[
'TASKID' => 8017,
'ITEMID' => 479
]
);
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.get", b24.Params{
"TASKID": 8017,
"ITEMID": 479,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("task.checklistitem.get: %w", err)
}
var item 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, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.TaskID)
Response Handling
HTTP Status: 200
{
"result": {
"ID": "495",
"TASK_ID": "8017",
"PARENT_ID": "457",
"CREATED_BY": "503",
"TITLE": "Prepare report Andrew Smith Jessica Johnson Andrew Brown",
"SORT_INDEX": "4",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "Y",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [
{
"ID": "3",
"TYPE": "U",
"NAME": "Andrew Brown",
"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": "Andrew Smith",
"PERSONAL_PHOTO": "231",
"PERSONAL_GENDER": "M",
"IMAGE": "https://mysite.com/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
"IS_COLLABER": false
},
{
"ID": "103",
"TYPE": "A",
"NAME": "Jessica 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": {
"1111": {
"ATTACHMENT_ID": 1111,
"NAME": "Invoice for Client.pdf",
"SIZE": "148238",
"FILE_ID": "989",
"DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1111&action=download&ncc=1",
"VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1111&action=show&ncc=1"
}
}
},
"time": {
"start": 1762755387,
"finish": 1762755387.104804,
"duration": 0.10480403900146484,
"processing": 0,
"date_start": "2025-11-10T09:16:27+02:00",
"date_finish": "2025-11-10T09:16:27+02:00",
"operating_reset_at": 1762755987,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with description of checklist item fields |
|
time |
Information about the request execution time |
Fields of the result object
|
Name |
Description |
|
ID |
Checklist item identifier |
|
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 |
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 status of the item. Can be |
|
TOGGLED_DATE |
Date and time of the status change in |
|
MEMBERS |
List of objects with description of participants |
|
ATTACHMENTS |
Object with description of attached files. Key — attachment file identifier |
Members Object
|
Name |
Description |
|
ID |
User identifier |
|
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 |
Attachment identifier |
|
NAME |
File name |
|
SIZE |
File size in bytes |
|
FILE_ID |
File identifier 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_#256; Param #1 (itemId) expected by method ctaskchecklistitem::get(), but not given.; 256\/TE\/WRONG_ARGUMENTS\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_#256; Param #1 (itemId) expected by method ctaskchecklistitem::get(), but not given.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E |
Required parameters |
|
|
error_description":"TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskchecklistitem::get() expected to be of type \u0022integer\u0022, but given something else.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E |
Incorrect type of value for |
|
|
TASKS_ERROR_EXCEPTION_#512; Check listitem not found or not accessible; 512/TE/ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE\u003Cbr\u003E |
Possible reasons:
|
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 the List of Checklist Items task.checklistitem.getlist
- 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