Get Time Entry by ID task.elapseditem.get
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:
taskWho can execute the method: any user
The method returns a time entry by its ID.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
TASKID* |
Task ID. The task ID can be obtained when creating a new task or by using the get task list method |
|
ITEMID* |
Time entry ID. This can be obtained when creating a new entry or by using the get time entry list method |
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.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID": 691,"ITEMID": 1,}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.elapseditem.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID": 691,"ITEMID": 1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.elapseditem.get
// 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 the payload returned in result (match the "response handling" section of the page)
type ElapsedItemResult = {
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 {
const response = await $b24.actions.v2.call.make<ElapsedItemResult>({
method: 'task.elapseditem.get',
params: {
TASKID: 691,
ITEMID: 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(result[0].ID, result[0].SECONDS, result[0].CREATED_DATE)
}
} 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 getElapsedItem() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.elapseditem.get',
params: {
TASKID: 691,
ITEMID: 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(result[0].ID, result[0].SECONDS, result[0].CREATED_DATE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getElapsedItem)
</script>
try {
$response = $b24Service
->core
->call(
'task.elapseditem.get',
[
'TASKID' => 691,
'ITEMID' => 1,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting elapsed item: ' . $e->getMessage();
}
BX24.callMethod(
'task.elapseditem.get',
{
"TASKID": 691,
"ITEMID": 1,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'task.elapseditem.get',
[
'TASKID' => 691,
'ITEMID' => 1,
]
);
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"
}
],
"time":{
"start":1712137817.343984,
"finish":1712137817.605804,
"duration":0.26182007789611816,
"processing":0.018325090408325195,
"date_start":"2024-04-03T12:50:17+03:00",
"date_finish":"2024-04-03T12:50:17+03:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Information about the time entry |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":"ERROR_CORE",
"error_description":"Task not found"
}
|
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 |
Possible Error Codes
|
Code |
Description |
|
|
Task not found |
|
|
Access denied |
|
|
Action not allowed |
|
|
Unknown error |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
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
- Time Tracking in Tasks: Overview of Methods
- Add Elapsed Time Record task.elapseditem.add
- Update Time Entry task.elapseditem.update
- Get a List of Time Tracking Records task.elapseditem.getlist
- Delete Time Entry task.elapseditem.delete
- Check Action Permission for task.elapseditem.isActionAllowed
- Get a List of Methods and Their Descriptions task.elapseditem.getmanifest