Get the list of users for the timeman.timecontrol.reports.users.get

Scope: timeman

Who can execute the method: any user

The method timeman.timecontrol.reports.users.get retrieves the list of users in the department.

The data returned by the method depends on the role:

  • an employee will receive only their own data,
  • a manager will receive data for their department,
  • an administrator will receive data for any department.

Method Parameters

Name
type

Description

DEPARTMENT_ID
integer

The identifier of the department. This parameter should only be specified by a manager or administrator.

The department identifier can be obtained using the get department list method.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DEPARTMENT_ID":15}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.timecontrol.reports.users.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DEPARTMENT_ID":15,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.timecontrol.reports.users.get
        
try
        {
        	const response = await $b24.callMethod(
        		'timeman.timecontrol.reports.users.get',
        		{
        			'DEPARTMENT_ID': 15
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.timecontrol.reports.users.get',
                    [
                        'DEPARTMENT_ID' => 15
                    ]
                );
        
            $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 time control reports: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'timeman.timecontrol.reports.users.get',
            {
                'DEPARTMENT_ID': 15
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'timeman.timecontrol.reports.users.get',
            [
                'DEPARTMENT_ID' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "id": 3,
                    "name": "Natalie Brooks",
                    "first_name": "Natalie",
                    "last_name": "Brooks",
                    "work_position": "IT Specialist",
                    "avatar": "http://test.bitrix24.com/upload/resize_cache/45749/7acf4ca766af5d8/main/c89/c89c6b73470635c/4R5A1256.png",
                    "personal_gender": "F",
                    "last_activity_date": "2025-05-29T16:41:00+02:00"
                }
            ],
            "time": {
                "start": 1748526089.625516,
                "finish": 1748526089.656787,
                "duration": 0.03127098083496094,
                "processing": 0.008746147155761719,
                "date_start": "2025-05-29T16:41:29+02:00",
                "date_finish": "2025-05-29T16:41:29+02:00",
                "operating_reset_at": 1748526689,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
array

Array of users

id
integer

User identifier

name
string

Full name of the user

first_name
string

First name

last_name
string

Last name

work_position
string

Job title

avatar
string

URL of the user's avatar.

If the value is empty, the user does not have an avatar.

personal_gender
string

Gender

last_activity_date
string

Date of the user's last activity in ATOM format

time
time

Information about the request execution time

Error Handling

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 allowed to be called 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 methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users

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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning