Get Mapped HCM Link Employee List humanresources.hcmlink.employee.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: humanresources.hcmlink

Who can execute the method: administrator

The humanresources.hcmlink.employee.list method retrieves a list of mapped employees from the HR system and Bitrix24.

The method can only be executed in the context of authorization of the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

company*
string

Company code in the HR system.

You can get the code using humanresources.hcmlink.company.list

limit
integer

Number of records per page.

Allowed values: 1 to 1000. Default value: 100

offset
integer

Offset for page navigation.

Default value: 0

updatedAt
string

Modification date in ISO 8601 format. If passed, the method returns records changed after this date

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"company":"hr-company-001","limit":50,"offset":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/humanresources.hcmlink.employee.list
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make({
            method: 'humanresources.hcmlink.employee.list',
            params: {
              company: 'hr-company-001',
              limit: 50,
              offset: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            console.info(response.getData()!.result)
          }
        } catch (error) {
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getHcmLinkEmployees() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'humanresources.hcmlink.employee.list',
                params: {
                  company: 'hr-company-001',
                  limit: 50,
                  offset: 0
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              console.info(response.getData().result)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getHcmLinkEmployees)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'humanresources.hcmlink.employee.list',
                    [
                        'company' => 'hr-company-001',
                        'limit' => 50,
                        'offset' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting employees: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'humanresources.hcmlink.employee.list',
            {
                company: 'hr-company-001',
                limit: 50,
                offset: 0
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'humanresources.hcmlink.employee.list',
            [
                'company' => 'hr-company-001',
                'limit' => 50,
                'offset' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see section "SDK for Go"
        res, err := client.Core().Call(ctx, "humanresources.hcmlink.employee.list", b24.Params{
        	"company": "hr-company-001",
        	"limit":   50,
        	"offset":  0,
        })
        if err != nil {
        	return fmt.Errorf("humanresources.hcmlink.employee.list: %w", err)
        }
        
        var items []struct {
        	ID        int `json:"id"`
        	Company   string `json:"company"`
        	Person    string `json:"person"`
        	Employees []struct {
        		ID        int            `json:"id"`
        		Employee  string         `json:"employee"`
        		Data      map[string]any `json:"data"`
        		CreatedAt string         `json:"createdAt"`
        	} `json:"employees"`
        	UserID    int    `json:"userId"`
        	Title     string `json:"title"`
        	CreatedAt string `json:"createdAt"`
        	UpdatedAt string `json:"updatedAt"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("response breakdown: %w", err)
        }
        for _, item := range items {
        	fmt.Println(item.ID, item.Person, item.UserID)
        }
        

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "id": 7,
                    "company": "hr-company-001",
                    "person": "person-001",
                    "employees": [
                        {
                            "id": 21,
                            "employee": "employee-001",
                            "data": {
                                "position": "Manager"
                            },
                            "createdAt": "2026-08-06T19:51:02+03:00"
                        }
                    ],
                    "userId": 25,
                    "title": "Klaus Weber",
                    "createdAt": "2026-08-06T19:51:02+03:00",
                    "updatedAt": "2026-08-06T19:51:02+03:00"
                }
            ],
            "time": {
                "start": 1739860000.123,
                "finish": 1739860000.456,
                "duration": 0.333,
                "processing": 0.111,
                "date_start": "2026-08-06T19:51:02+03:00",
                "date_finish": "2026-08-06T19:51:02+03:00"
            }
        }
        

Returned Data

Name
type

Description

result
array

List of mapped employees (detailed description)

time
time

Request execution time information

result Array Element

Name
type

Description

id
integer

Individual ID in HCM Link

company
string

Company code in the HR system

person
string

Individual code in the HR system

employees
array

List of HR system employees linked to the individual (detailed description)

userId
integer

Bitrix24 user ID

title
string

Employee name

createdAt
string

Creation date in ISO 8601 format

updatedAt
string

Modification date in ISO 8601 format

employees Array Element

Name
type

Description

id
integer

HCM Link employee ID

employee
string

Employee code in the HR system

data
object

Employee data

createdAt
string

Creation date in ISO 8601 format

Error Handling

HTTP status: 200, 403

{
            "error": 510,
            "error_description": "Operation failed"
        }
        

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

When It Occurs

510

Operation failed

The company was not found or the company parameter is not passed

ACCESS_DENIED

Access denied! Access denied.

The user is not an administrator

WRONG_AUTH_TYPE

Application context required

The method was not called in the application context

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