Get the List of Comments task.commentitem.getlist

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: task

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

The method task.commentitem.getlist retrieves a list of task comments.

DEPRECATED

Development of this method has been halted since version tasks 25.700.0. The method task.commentitem.getlist does not work in the new task card; use the im.dialog.messages.get method to work 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 identifier.

The task identifier can be obtained when creating a new task or by using the get task list method.

ORDER
object

An object for sorting the result in the form {"field": "sort value", ... }.

You can sort by the following fields:

  • ID — comment identifier
  • AUTHOR_ID — comment author's identifier
  • AUTHOR_NAME — author's name
  • AUTHOR_EMAIL — author's email address
  • POST_DATE — comment publication date

The sorting direction can take the following values:

  • asc — ascending
  • desc — descending

By default, the result is sorted in descending order by comment identifier.

FILTER
object

An object for filtering the result in the form {"field": "filter value", ... }. The value of the filtered field can be a single value or an array of values.

You can filter by the following fields:

  • ID — comment identifier
  • AUTHOR_ID — comment author's identifier
  • AUTHOR_NAME — author's name
  • POST_DATE — comment publication date

You can specify a prefix for the filtered field indicating the type of filtering:

  • ! — not equal
  • <= — less than or equal to
  • < — less than
  • >= — greater than or equal to
  • > — greater than

By default, records are not filtered.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ORDER":{"POST_DATE":"asc"},"FILTER":{"AUTHOR_ID":503,">=POST_DATE":"2025-01-01"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.commentitem.getlist
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ORDER":{"POST_DATE":"asc"},"FILTER":{"AUTHOR_ID":503,">=POST_DATE":"2025-01-01"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.commentitem.getlist
        
// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each comment item returned in the result array
        type TaskCommentItem = {
          ID: string
          AUTHOR_ID: string
          AUTHOR_NAME: string
          AUTHOR_EMAIL: string
          POST_DATE: ISODate | null
          POST_MESSAGE: string
          POST_MESSAGE_HTML: string | null
          ATTACHED_OBJECTS: Record<string, {
            ATTACHMENT_ID: string
            NAME: string
            SIZE: string
            FILE_ID: string
            DOWNLOAD_URL: string
            VIEW_URL: string
          }>
        }
        
        try {
          // task.commentitem.getlist 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<TaskCommentItem[]>({
            method: 'task.commentitem.getlist',
            params: {
              TASKID: 8017,
              ORDER: {
                POST_DATE: 'asc',
              },
              FILTER: {
                AUTHOR_ID: 503,
                '>=POST_DATE': '2025-01-01',
              },
            },
            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('Comments fetched:', result.length, result)
          }
        } 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 getTaskCommentList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // task.commentitem.getlist 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: 'task.commentitem.getlist',
                params: {
                  TASKID: 8017,
                  ORDER: {
                    POST_DATE: 'asc',
                  },
                  FILTER: {
                    AUTHOR_ID: 503,
                    '>=POST_DATE': '2025-01-01',
                  },
                },
                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('Comments fetched:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getTaskCommentList)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'task.commentitem.getlist',
                    [
                        'TASKID' => 8017,
                        'ORDER' => [
                            'POST_DATE' => 'asc',
                        ],
                        'FILTER' => [
                            'AUTHOR_ID' => 503,
                            '>=POST_DATE' => '2025-01-01',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing the data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting task comments: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'task.commentitem.getlist',
            {
                "TASKID": 8017,
                "ORDER": {
                    "POST_DATE": "asc",
                },
                "FILTER": {
                    "AUTHOR_ID": 503,
                    ">=POST_DATE": "2025-01-01",
                }
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'task.commentitem.getlist',
            [
                'TASKID' => 8017,
                'ORDER' => [
                    'POST_DATE' => 'asc',
                ],
                'FILTER' => [
                    'AUTHOR_ID' => 503,
                    '>=POST_DATE' => '2025-01-01',
                ]
            ]
        );
        
        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.commentitem.getlist", b24.Params{
        	"TASKID": 8017,
        	"ORDER": b24.Params{
        		"POST_DATE": "asc",
        	},
        	"FILTER": b24.Params{
        		"AUTHOR_ID":   503,
        		">=POST_DATE": "2025-01-01",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("task.commentitem.getlist: %w", err)
        }
        
        var items []struct {
        	ID          b24.ID `json:"ID"`
        	AuthorID    b24.ID `json:"AUTHOR_ID"`
        	AuthorName  string `json:"AUTHOR_NAME"`
        	AuthorEmail string `json:"AUTHOR_EMAIL"`
        	PostDate    string `json:"POST_DATE"`
        	PostMessage string `json:"POST_MESSAGE"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.AuthorID)
        }
        

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:31:00+02:00",
                    "POST_MESSAGE": "Photos attached",
                    "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"
                        }
                    }
                },
                {
                    "POST_MESSAGE_HTML": null,
                    "ID": "3155",
                    "AUTHOR_ID": "503",
                    "AUTHOR_NAME": "John Smith",
                    "AUTHOR_EMAIL": "",
                    "POST_DATE": "2025-07-15T14:30:00+02:00",
                    "POST_MESSAGE": "Prepared new photos",
                    "ATTACHED_OBJECTS": {}
                }
            ],
            "time": {
                "start": 1753270901.224447,
                "finish": 1753270901.343166,
                "duration": 0.11871910095214844,
                "processing": 0.06380701065063477,
                "date_start": "2025-07-23T14:41:41+02:00",
                "date_finish": "2025-07-23T14:41:41+02:00",
                "operating_reset_at": 1753271501,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
array

An array of objects. Each object contains a description of the comment.

POST_MESSAGE_HTML
string

HTML code of the comment.

ID
string

Comment identifier.

AUTHOR_ID
string

Comment author's identifier.

AUTHOR_NAME
string

Comment author's name.

AUTHOR_EMAIL
string

Comment author's email.

POST_DATE
string

Date and time of comment creation.

POST_MESSAGE
string

Text of the comment.

ATTACHED_OBJECTS
object

An object containing information about attachments. The key of the object is the attachment identifier, and the value is an object with file description.

time
time

Information about the request execution time.

ATTACHED_OBJECTS Object

Name
type

Description

ATTACHMENT_ID
string

Attachment identifier.

NAME
string

File name.

SIZE
string

File size in bytes.

FILE_ID
string

File identifier 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_CORE",
            "error_description":"TASKS_ERROR_EXCEPTION_#256; Param #1 (arOrder) for method ctaskcommentitem::getlist() must not contain key ">=POST_DATE".; 256/TE/WRONG_ARGUMENTS.<br>"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ERROR_CORE

TASKS_ERROR_EXCEPTION_#8; Action failed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED

Invalid parameter value specified or no access permission to the task.

ERROR_CORE

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

Invalid type of value specified for the parameter, for example, for TASKID.

ERROR_CORE

TASKS_ERROR_EXCEPTION_#256; Param #1 (arOrder) for method ctaskcommentitem::getlist() must not contain key ">=POST_DATE".; 256/TE/WRONG_ARGUMENTS

Parameters are specified in the wrong order.

ERROR_CORE

TASKS_ERROR_EXCEPTION_#256; Param #2 (arFilter) for method ctaskcommentitem::getlist() must not contain key "%POST_DATE".; 256/TE/WRONG_ARGUMENTS

Incorrect parameter name or prefix specified for filtering.

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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