Get a List of Time Records timeman.record.list
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:
timemanWho can execute the method: a user with the "Read according to subordination settings" or "Read all records" access permission.
The method timeman.record.list returns a list of time records for an employee.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter* |
Conditions for filtering records in the format:
The Available fields:
For |
|
select |
List of fields to return in the response. Available fields:
|
|
order |
Sorting results in the format Available values:
Available fields for sorting:
|
|
pagination |
Pagination parameters:
|
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/timeman.record.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["userId",1],["startTime","between",["2026-06-01T00:00:00+02:00","2026-06-30T23:59:59+02:00"]]],"select":["id","startTime","endTime","duration"],"order":{"startTime":"DESC"},"pagination":{"page":1,"limit":50,"offset":0}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/timeman.record.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["userId",1],["startTime","between",["2026-06-01T00:00:00+02:00","2026-06-30T23:59:59+02:00"]]],"select":["id","startTime","endTime","duration"],"order":{"startTime":"DESC"},"pagination":{"page":1,"limit":50,"offset":0},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/timeman.record.list
// 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 TimemanRecordItem = {
id: number
startTime: ISODate
endTime: ISODate
duration: number
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type TimemanRecordListResult = {
items: TimemanRecordItem[]
}
try {
// timeman.record.list 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 + `pagination` variant when sort matters.
const response = await $b24.actions.v3.call.make<TimemanRecordListResult>({
method: 'timeman.record.list',
params: {
filter: [
['userId', 1],
['startTime', 'between', ['2026-06-01T00:00:00+03:00', '2026-06-30T23:59:59+03:00']],
],
select: [
'id',
'startTime',
'endTime',
'duration',
],
order: {
startTime: 'DESC',
},
pagination: {
page: 1,
limit: 50,
offset: 0,
},
},
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('Records fetched:', result.items.length, result.items)
}
} 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 fetchTimemanRecordList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// timeman.record.list 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 + `pagination` variant when sort matters.
const response = await $b24.actions.v3.call.make({
method: 'timeman.record.list',
params: {
filter: [
['userId', 1],
['startTime', 'between', ['2026-06-01T00:00:00+03:00', '2026-06-30T23:59:59+03:00']],
],
select: [
'id',
'startTime',
'endTime',
'duration',
],
order: {
startTime: 'DESC',
},
pagination: {
page: 1,
limit: 50,
offset: 0,
},
},
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('Records fetched:', result.items.length, result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchTimemanRecordList)
</script>
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'timeman.record.list',
[
'filter' => [
['userId', 1],
['startTime', 'between', ['2026-06-01T00:00:00+02:00', '2026-06-30T23:59:59+02:00']],
],
'select' => [
'id',
'startTime',
'endTime',
'duration'
],
'order' => [
'startTime' => 'DESC'
],
'pagination' => [
'page' => 1,
'limit' => 50,
'offset' => 0
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'timeman.record.list',
{
filter: [
['userId', 1],
['startTime', 'between', ['2026-06-01T00:00:00+02:00', '2026-06-30T23:59:59+02:00']]
],
select: [
'id',
'startTime',
'endTime',
'duration'
],
order: {
startTime: 'DESC'
},
pagination: {
page: 1,
limit: 50,
offset: 0
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'timeman.record.list',
[
'filter' => [
['userId', 1],
['startTime', 'between', ['2026-06-01T00:00:00+02:00', '2026-06-30T23:59:59+02:00']]
],
'select' => [
'id',
'startTime',
'endTime',
'duration'
],
'order' => [
'startTime' => 'DESC'
],
'pagination' => [
'page' => 1,
'limit' => 50,
'offset' => 0
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"items": [
{
"id": 177,
"startTime": "2026-06-02T17:38:24+02:00",
"endTime": "2026-06-02T17:39:06+02:00",
"duration": 28
}
]
},
"time": {
"start": 1780411219,
"finish": 1780411219.167315,
"duration": 0.16731500625610352,
"processing": 0,
"date_start": "2026-06-02T17:40:19+02:00",
"date_finish": "2026-06-02T17:40:19+02:00",
"operating_reset_at": 1780411819,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing response data |
|
items |
Array of objects with records. The response structure depends on |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error during request object validation",
"validation": [
{
"field": "filter.userId",
"message": "Required field `filter.userId` is not specified"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Access denied |
Check the read permission for time records for the specified employee and the |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Required field |
Provide a filter with a condition for |
Filter Errors
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Multiple different |
Only provide one employee identifier in the filter |
Pagination Errors
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Unable to recognize pagination parameter |
Provide numeric values. |
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 |