Получить список сопоставленных сотрудников HCM Link humanresources.hcmlink.employee.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: humanresources.hcmlink

Кто может выполнять метод: администратор

Метод humanresources.hcmlink.employee.list возвращает список сопоставленных сотрудников системы кадрового учета и Битрикс24.

Метод работает только в контексте авторизации приложения.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

company*
string

Код компании в системе кадрового учета.

Получить код можно методом humanresources.hcmlink.company.list

limit
integer

Количество записей на странице.

Допустимые значения — от 1 до 1000. По умолчанию 100

offset
integer

Смещение для постраничной навигации.

По умолчанию 0

updatedAt
string

Дата изменения в формате ISO 8601. Если передана, метод вернет записи, измененные после этой даты

Примеры кода

Как использовать примеры в документации

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 и ctx уже созданы — см. раздел «SDK для 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("разбор ответа: %w", err)
}
for _, item := range items {
	fmt.Println(item.ID, item.Person, item.UserID)
}

Обработка ответа

HTTP-статус: 200

{
    "result": [
        {
            "id": 7,
            "company": "hr-company-001",
            "person": "person-001",
            "employees": [
                {
                    "id": 21,
                    "employee": "employee-001",
                    "data": {
                        "position": "Менеджер"
                    },
                    "createdAt": "2026-08-06T19:51:02+03:00"
                }
            ],
            "userId": 25,
            "title": "Иван Петров",
            "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"
    }
}

Возвращаемые данные

Название
тип

Описание

result
array

Список сопоставленных сотрудников (подробное описание)

time
time

Информация о времени выполнения запроса

Элемент массива result

Название
тип

Описание

id
integer

Идентификатор физического лица в HCM Link

company
string

Код компании в системе кадрового учета

person
string

Код физического лица в системе кадрового учета

employees
array

Список сотрудников системы кадрового учета, связанных с физическим лицом (подробное описание)

userId
integer

Идентификатор пользователя Битрикс24

title
string

Имя сотрудника

createdAt
string

Дата создания в формате ISO 8601

updatedAt
string

Дата изменения в формате ISO 8601

Элемент массива employees

Название
тип

Описание

id
integer

Идентификатор сотрудника HCM Link

employee
string

Код сотрудника в системе кадрового учета

data
object

Данные сотрудника

createdAt
string

Дата создания в формате ISO 8601

Обработка ошибок

HTTP-статус: 200, 403

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

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

Когда возникает

510

Operation failed

Компания не найдена или не передан параметр company

ACCESS_DENIED

Access denied! Access denied.

Пользователь не является администратором

WRONG_AUTH_TYPE

Application context required

Метод вызван не в контексте приложения

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение