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

Who can execute the method: a user with the "Read according to subordination settings" or "Read all records" access permission.

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The method timeman.record.list returns a list of time records for an employee.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter*
array

Conditions for filtering records in the format:

  • ["field", "operator", value]
  • ["field", value], default operator is =

The userId parameter is required.

Available fields:

  • userId — employee identifier
  • startTime — start time of the work interval

For startTime, the following operators are supported: =, >, >=, <, <=, between.

More about filtering in REST 3.0

select
array

List of fields to return in the response.

Available fields:

  • id — record identifier
  • userId — employee identifier
  • startTime — start time of the work interval
  • endTime — end time of the work interval
  • duration — duration of the work interval in seconds
  • breakLength — duration of breaks in seconds
  • state — state of the record
  • isApproved — approval status of the record

order
object

Sorting results in the format { "field": "value" }.

Available values:

  • ASC — ascending
  • DESC — descending

Available fields for sorting:

  • id — record identifier
  • userId — employee identifier
  • startTime — start time of the work interval
  • endTime — end time of the work interval
  • duration — duration of the work interval in seconds

pagination
object

Pagination parameters:

  • page — page number
  • limit — number of records per page, default is 50
  • offset — record offset. If page and limit are provided, the offset is calculated automatically

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>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        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": 20,
            "offset": 0,
        }
        
        try:
            bitrix_response = client.timeman.record.list(
                filter=filter,
                select=select,
                order=order,
                pagination=pagination,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "timeman.record.list", b24.Params{
        	"filter": []any{
        		[]any{"userId", 1},
        		[]any{
        			"startTime",
        			"between",
        			[]string{"2026-06-01T00:00:00+03:00", "2026-06-30T23:59:59+03:00"},
        		},
        	},
        	"select": []string{"id", "startTime", "endTime", "duration"},
        	"order": b24.Params{
        		"startTime": "DESC",
        	},
        	"pagination": b24.Params{
        		"page":   1,
        		"limit":  50,
        		"offset": 0,
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("timeman.record.list: %w", err)
        }
        
        // The method wraps the response in an object with the "items" key.
        raw, ok := b24.Unwrap(res.Result, "items")
        if !ok {
        	return fmt.Errorf("no items key in the response")
        }
        
        var items []struct {
        	ID        b24.ID `json:"id"`
        	StartTime string `json:"startTime"`
        	EndTime   string `json:"endTime"`
        	Duration  int    `json:"duration"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }
        

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
type

Description

result
object

Object containing response data

items
array

Array of objects with records. The response structure depends on select

time
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
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

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

filter.userId

Access denied

Check the read permission for time records for the specified employee and the timeman scope

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error Description

How to Fix

filter.userId

Required field filter.userId is not specified

Provide a filter with a condition for userId

Filter Errors

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error Description

How to Fix

filter.userId

Multiple different userId values were provided in one request

Only provide one employee identifier in the filter

Pagination Errors

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error Description

How to Fix

limit
offset
page

Unable to recognize pagination parameter #PAGE#

Provide numeric values. limit must not be equal to 0

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

The REST API is available only on commercial plans. 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