Get Comment by ID task.commentitem.get

Scope: task

Who can execute the method: any user with read access permission for the task or higher

The method task.commentitem.get retrieves a comment by its ID.

Development of the method has been halted since version of the module tasks 25.700.0

The method task.commentitem.get does not work in the new task card, use the method im.dialog.messages.get for working with task chat.

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
type

Description

TASKID*
integer

Task ID.

The task ID can be obtained when creating a new task or by using the method to get the list of tasks

ITEMID*
integer

Comment ID.

The comment ID can be obtained when adding a new comment or by using the method to get the list of comments

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ITEMID":3157}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.commentitem.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ITEMID":3157,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.commentitem.get
        
try
        {
        	const response = await $b24.callMethod(
        		'task.commentitem.get',
        		{
        			"TASKID": 8017,
        			"ITEMID": 3157
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'task.commentitem.get',
                    [
                        'TASKID' => 8017,
                        'ITEMID' => 3157
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting task comments: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'task.commentitem.get',
            {
                "TASKID": 8017,
                "ITEMID": 3157
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'task.commentitem.get',
            [
                'TASKID' => 8017,
                'ITEMID' => 3157
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP Status: 200

{
            "result": {
                "POST_MESSAGE_HTML": null,
                "ID": "3157",
                "AUTHOR_ID": "503",
                "AUTHOR_NAME": "John Smith",
                "AUTHOR_EMAIL": "",
                "POST_DATE": "2025-07-15T14:30:00+02:00",
                "POST_MESSAGE": "Text of the new comment for the task",
                "ATTACHED_OBJECTS": {
                    "973": {
                        "ATTACHMENT_ID": "973",
                        "NAME": "photo1.png",
                        "SIZE": "1495700",
                        "FILE_ID": "4755",
                        "DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=973&auth%5Bauth%5D=3edf7ca92&action=download&ncc=1",
                        "VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=973&auth%5Bauth%5D=3edf7ca92&action=show&ncc=1"
                    },
                    "975": {
                        "ATTACHMENT_ID": "975",
                        "NAME": "photo2.png",
                        "SIZE": "1017053",
                        "FILE_ID": "4753",
                        "DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=975&auth%5Bauth%5D=3edf7ca92&action=download&ncc=1",
                        "VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=975&auth%5Bauth%5D=3edf7ca92&action=show&ncc=1"
                    }
                }
            },
            "time": {
                "start": 1753274863.280788,
                "finish": 1753274863.362892,
                "duration": 0.08210396766662598,
                "processing": 0.04009890556335449,
                "date_start": "2025-07-23T15:47:43+02:00",
                "date_finish": "2025-07-23T15:47:43+02:00",
                "operating_reset_at": 1753275463,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object describing the comment

POST_MESSAGE_HTML
string

HTML code of the comment

ID
string

Comment ID

AUTHOR_ID
string

Author ID of the comment

AUTHOR_NAME
string

Name of the comment author

AUTHOR_EMAIL
string

Email of the comment author

POST_DATE
string

Date and time of comment creation

POST_MESSAGE
string

Text of the comment

ATTACHED_OBJECTS
object

Object containing information about attachments. The key of the object is the attachment ID, and the value is the object with file description

time
time

Information about the request execution time

ATTACHED_OBJECTS Object

Name
type

Description

ATTACHMENT_ID
string

Attachment ID

NAME
string

File name

SIZE
string

File size in bytes

FILE_ID
string

File ID on Drive

DOWNLOAD_URL
string

URL for downloading the file

VIEW_URL
string

URL for viewing the file

Error Handling

HTTP Status: 400

{
            "error":"ERROR_CODE",
            "error_description":"TASKS_ERROR_EXCEPTION_#512; Check listitem not found or not accessible; 512/TE/ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE.<br>"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

Code

Description

Value

ERROR_CORE

TASKS_ERROR_EXCEPTION_#512; Check listitem not found or not accessible; 512/TE/ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE

The error is returned in the following cases:

  • Incorrect order of parameters in the method
  • Task or comment with the specified ID not found
  • No access permission to the task

ERROR_CORE

TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskcommentitem::get() expected to be of type "integer", but given something else.; 256/TE/WRONG_ARGUMENTS

Incorrect value type for the parameter, for example, for TASKID

ERROR_CORE

TASKS_ERROR_EXCEPTION_#256; Param #1 (itemId) expected by method ctaskcommentitem::get(), but not given.; 256/TE/WRONG_ARGUMENTS

Required parameter not specified, for example, ITEMID

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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