Get a list of methods and their description task.checklistitem.getmanifest
Scope:
taskWho can execute the method: any user
The method task.checklistitem.getmanifest retrieves information about the methods for working with task checklist items task.checklistitem.*.
It is recommended to use the result only as a reference, as the structure of the method's response can be changed by the developer at any time.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.checklistitem.getmanifest
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.checklistitem.getmanifest
try
{
const response = await $b24.callMethod(
'task.checklistitem.getmanifest',
[]
);
const result = response.getData().result;
console.log('Manifest data:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'task.checklistitem.getmanifest',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting manifest: ' . $e->getMessage();
}
BX24.callMethod(
'task.checklistitem.getmanifest',
{},
function(result)
{
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.checklistitem.getmanifest',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"Manifest version": "2.0",
"Warning": "don't rely on format of this manifest, it can be changed without any notification",
"REST: shortname alias to class": "checklistitem",
"REST: writable checklistitem data fields": [
"PARENT_ID",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"MEMBERS"
],
"REST: readable checklistitem data fields": [
"ID",
"TASK_ID",
"PARENT_ID",
"CREATED_BY",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"TOGGLED_BY",
"TOGGLED_DATE",
"MEMBERS",
"ATTACHMENTS"
],
"REST: sortable checklistitem data fields": [
"ID",
"PARENT_ID",
"CREATED_BY",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"TOGGLED_BY",
"TOGGLED_DATE"
],
"REST: date fields": [
"TOGGLED_DATE"
],
"REST: available methods": {
"getmanifest": {
"staticMethod": true,
"params": []
},
"get": {
"mandatoryParamsCount": 2,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "itemId",
"type": "integer"
}
],
"allowedKeysInReturnValue": [
"ID",
"TASK_ID",
"PARENT_ID",
"CREATED_BY",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"TOGGLED_BY",
"TOGGLED_DATE",
"MEMBERS",
"ATTACHMENTS"
]
},
"getlist": {
"staticMethod": true,
"mandatoryParamsCount": 1,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "arOrder",
"type": "array",
"allowedKeys": [
"ID",
"PARENT_ID",
"CREATED_BY",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"TOGGLED_BY",
"TOGGLED_DATE"
]
}
],
"allowedKeysInReturnValue": [
"ID",
"TASK_ID",
"PARENT_ID",
"CREATED_BY",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"TOGGLED_BY",
"TOGGLED_DATE",
"MEMBERS",
"ATTACHMENTS"
],
"collectionInReturnValue": true
},
"add": {
"staticMethod": true,
"mandatoryParamsCount": 2,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "arFields",
"type": "array",
"allowedKeys": [
"PARENT_ID",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"MEMBERS"
]
}
]
},
"update": {
"staticMethod": false,
"mandatoryParamsCount": 3,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "itemId",
"type": "integer"
},
{
"description": "arFields",
"type": "array",
"allowedKeys": [
"PARENT_ID",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT",
"MEMBERS"
]
}
]
},
"delete": {
"staticMethod": false,
"mandatoryParamsCount": 2,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "itemId",
"type": "integer"
}
]
},
"complete": {
"staticMethod": false,
"mandatoryParamsCount": 2,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "itemId",
"type": "integer"
}
]
},
"renew": {
"staticMethod": false,
"mandatoryParamsCount": 2,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "itemId",
"type": "integer"
}
]
},
"moveafteritem": {
"staticMethod": false,
"mandatoryParamsCount": 3,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "itemId",
"type": "integer"
},
{
"description": "afterItemId",
"type": "integer"
}
]
},
"isactionallowed": {
"staticMethod": false,
"mandatoryParamsCount": 3,
"params": [
{
"description": "taskId",
"type": "integer"
},
{
"description": "itemId",
"type": "integer"
},
{
"description": "actionId",
"type": "integer"
}
]
}
}
},
"time": {
"start": 1769070876,
"finish": 1769070877.009113,
"duration": 1.009113073348999,
"processing": 0,
"date_start": "2026-01-22T11:34:36+01:00",
"date_finish": "2026-01-22T11:34:37+01:00",
"operating_reset_at": 1769071477,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object describing the methods |
|
time |
Information about the request execution time |
Error Handling
|
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 |
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
- Checklists: Overview of Methods
- Add checklist item task.checklistitem.add
- Update checklist item task.checklistitem.update
- Get checklist item task.checklistitem.get
- Get the list of checklist items task.checklistitem.getlist
- Delete checklist item task.checklistitem.delete
- Move Checklist Item task.checklistitem.moveafteritem
- Mark checklist item as completed task.checklistitem.complete
- Mark a checklist item as incomplete task.checklistitem.renew
- Check Action Permission for task.checklistitem.isactionallowed