Get Task Description task.item.getdescription

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

Who can execute the method: any user

This method returns the task description.

DEPRECATED

The development of this method has been discontinued. Use tasks.task.get.

Method Parameters

Name

Description

TASKID

Task identifier

FORMAT

Acceptable values:

  • 1 (corresponds to PHP constant CTaskItem::DESCR_FORMAT_RAW) — the description will be returned in the format it is stored in the database (HTML or BB-code), no sanitization will be performed
  • 2 (corresponds to PHP constant CTaskItem::DESCR_FORMAT_HTML) — the description will be returned in HTML format, sanitized beforehand (if enabled in task module settings)
  • 3 (corresponds to PHP constant CTaskItem::DESCR_FORMAT_PLAIN_TEXT) — the description will be returned as plain text (without HTML tags)

It is mandatory to follow the order of parameters in the request. If this order is violated, the request will be executed with errors.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":13,"USERID":1}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.getdescription
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":13,"USERID":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.item.getdescription
        
// 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
        
        // TODO: verify API version
        // Shape of the payload returned in result
        type TaskDescriptionResult = string
        
        try {
          const response = await $b24.actions.v2.call.make<TaskDescriptionResult>({
            method: 'task.item.getdescription',
            params: {
              TASKID: 13,
              USERID: 1,
            },
            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('Task description:', 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 getTaskDescription() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'task.item.getdescription',
                params: {
                  TASKID: 13,
                  USERID: 1,
                },
                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('Task description:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getTaskDescription)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'task.item.getdescription',
                    [13, 1]
                );
        
            $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 description: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'task.item.getdescription',
            [13, 1],
            function(result)
            {
                console.info(result.data());
                console.log(result);
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'task.item.getdescription',
            [
                'TASKID' => 13,
                'USERID' => 1
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';