Get Mapped HCM Link Employee List humanresources.hcmlink.employee.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to 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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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