Get a List of Time Tracking Records task.elapseditem.getlist

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 a list of time tracking records for a task.

Method Parameters

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

Object for sorting the result (detailed description provided below)

FILTER
object

Object for filtering the result (detailed description provided below)

SELECT
array

Array of fields of records that will be returned by the method. You can specify only the fields you need. If the array contains the value "*", all available fields will be returned.

By default, all fields of the main request table will be returned

PARAMS
object

Object for call options. The element is an object NAV_PARAMS of the form {'call option': 'value' [, ...]} (detailed description provided below) in structure

Warning

It is mandatory to follow the specified order of parameters in the request as shown in the table. Otherwise, the request will execute with errors.

Note

Features of manually adding information about work time that was actually performed several days ago. In this case, the values of some fields change:

  • CREATED_DATE — start date
  • DATE_START — record creation date
  • DATE_STOP — record end date

ORDER Parameter

Name
type

Description

ID
string

Identifier of the time tracking record. Can take values:

  • asc — ascending
  • desc — descending

USER_ID
string

Identifier of the user on behalf of whom the time tracking record was made. Can take values:

  • asc — ascending
  • desc — descending

MINUTES
string

Time spent, in minutes. Can take values:

  • asc — ascending
  • desc — descending

SECONDS
string

Time spent, in seconds. Can take values:

  • asc — ascending
  • desc — descending

CREATED_DATE
string

Record creation date. Can take values:

  • asc — ascending
  • desc — descending

DATE_START
string

Start date. Can take values:

  • asc — ascending
  • desc — descending

DATE_STOP
string

End date. Can take values:

  • asc — ascending
  • desc — descending

FILTER Parameter

Name
type

Description

ID
integer

Identifier of the time tracking record

USER_ID
integer

Identifier of the user on behalf of whom the time tracking record was made

CREATED_DATE
datetime

Record creation date

Note

Before the name of the filtered field, you can specify the type of filtering:

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

'filter values' — a single value or an array

Name
type

Description

nPageSize
integer

Number of items per page. To limit the load on pagination, a limit of 50 records is imposed

iNumPage
integer

Page number in pagination

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '[{"ID": "desc"},{">=CREATED_DATE": "2024-02-16"}]' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.elapseditem.getlist
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{[{"ID": "desc"},{">=CREATED_DATE": "2024-02-16"}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.elapseditem.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
        
        type ElapsedItem = {
          ID: string
          TASK_ID: string
          USER_ID: string
          COMMENT_TEXT: string
          SECONDS: string
          MINUTES: string
          SOURCE: string
          CREATED_DATE: ISODate | null
          DATE_START: ISODate | null
          DATE_STOP: ISODate | null
        }
        
        try {
          // task.elapseditem.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<ElapsedItem[]>({
            method: 'task.elapseditem.getlist',
            params: {
              TASKID: 1,
              ORDER: { ID: 'desc' },
              FILTER: { '>=CREATED_DATE': '2024-02-16' },
              SELECT: ['ID', 'TASK_ID'],
              PARAMS: { NAV_PARAMS: { nPageSize: 2 } },
            },
            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('Elapsed items count:', result.length, 'First item:', result[0])
          }
        } 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 getElapsedItems() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // task.elapseditem.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.elapseditem.getlist',
                params: {
                  TASKID: 1,
                  ORDER: { ID: 'desc' },
                  FILTER: { '>=CREATED_DATE': '2024-02-16' },
                  SELECT: ['ID', 'TASK_ID'],
                  PARAMS: { NAV_PARAMS: { nPageSize: 2 } },
                },
                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('Elapsed items count:', result.length, 'First item:', result[0])
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getElapsedItems)
        </script>
        
try {
            // Get all time tracking records sorted by ID in descending order.
            // Only records with ID less than 50 will be filtered.
            $response1 = $b24Service
                ->core
                ->call(
                    'task.elapseditem.getlist',
                    [
                        1,
                        ['ID' => 'desc'],
                        ['<ID' => 50],
                    ]
                );
        
            $result1 = $response1
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result1, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting elapsed time records: ' . $e->getMessage();
        }
        
        try {
            // Get a sample of time tracking based on general filtering conditions. For example, select data on labor costs from a specified date:
            $response2 = $b24Service
                ->core
                ->call(
                    'task.elapseditem.getlist',
                    [
                        ['ID' => 'desc'],
                        ['>=CREATED_DATE' => '2024-02-16'],
                        ['ID', 'TASK_ID'],
                        [
                            'NAV_PARAMS' => [
                                'nPageSize' => 2,
                            ],
                        ],
                    ]
                );
        
            $result2 = $response2
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result2, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting elapsed time records: ' . $e->getMessage();
        }
        
// Get all time tracking records sorted by ID in descending order.
        // Only records with ID less than 50 will be filtered.
        BX24.callMethod(
            'task.elapseditem.getlist',
            [
                1, 
                {'ID': 'desc'},
                {'<ID': 50}
            ],
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        // Get a sample of time tracking based on general filtering conditions. For example, select data on labor costs from a specified date:
        BX24.callMethod(
            'task.elapseditem.getlist',
            [
                {'ID': 'desc'}, 
                {'>=CREATED_DATE': '2024-02-16'},
                ['ID', 'TASK_ID'],
                {"NAV_PARAMS":{
                        "nPageSize":2
                    }
                },
            ],
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'task.elapseditem.getlist',
            [
                "ORDER" => ["ID" => "DESC"],            // Sort by ID - descending
                "FILTER" => [">ID" => 1],               // Filter
                "SELECT" => ['ID', 'TASK_ID'],          // Selection - only ID of the record and task
                "PARAMS" => ['NAV_PARAMS' => [          // Pagination
                        "nPageSize" => 2,                   // 2 items per page
                        'iNumPage' => 2                     // page number 2
                    ]
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP Status: 200

{
            "result":[
                {
                    "ID": "1",
                    "TASK_ID": "691",
                    "USER_ID": "1",
                    "COMMENT_TEXT": "1",
                    "SECONDS": "3600",
                    "MINUTES": "60",
                    "SOURCE": "2",
                    "CREATED_DATE": "2024-05-16T10:33:00+02:00",
                    "DATE_START": "2024-05-16T10:33:15+02:00",
                    "DATE_STOP": "2024-05-16T10:33:15+02:00"
                }
            ],
            "total": 1,
            "time":{
                "start":1712137817.343984,
                "finish":1712137817.605804,
                "duration":0.26182007789611816,
                "processing":0.018325090408325195,
                "date_start":"2024-04-03T12:50:17+02:00",
                "date_finish":"2024-04-03T12:50:17+02:00"
            }
        }
        

Returned Data

Name
type

Description

result
array

Array of objects with information about time tracking records for the task

total
integer

Total number of records found

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error":"ERROR_CORE",
            "error_description":"ACTION_NOT_ALLOWED"
        }
        

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

0x100002

Access denied

0x000004

Action not allowed

0x000040

Unknown error

0x000100

Invalid method parameters provided

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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