Получить список компаний HCM Link humanresources.hcmlink.company.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
humanresources.hcmlinkКто может выполнять метод: администратор
Метод humanresources.hcmlink.company.list возвращает список компаний, подключенных к интеграции HCM Link.
Метод работает только в контексте авторизации приложения.
Параметры метода
|
Название |
Описание |
|
limit |
Количество записей на странице. Допустимые значения — от 1 до 1000. По умолчанию 100 |
|
offset |
Смещение для постраничной навигации. По умолчанию 0 |
|
userId |
Идентификатор пользователя Битрикс24. Если передан, метод вернет компании, связанные с этим пользователем |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"limit":50,"offset":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/humanresources.hcmlink.company.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.company.list',
params: {
limit: 50,
offset: 0,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getHcmLinkCompanies() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'humanresources.hcmlink.company.list',
params: {
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', getHcmLinkCompanies)
</script>
try {
$response = $b24Service
->core
->call(
'humanresources.hcmlink.company.list',
[
'limit' => 50,
'offset' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting companies: ' . $e->getMessage();
}
BX24.callMethod(
'humanresources.hcmlink.company.list',
{
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.company.list',
[
'limit' => 50,
'offset' => 0,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "humanresources.hcmlink.company.list", b24.Params{
"limit": 50,
"offset": 0,
})
if err != nil {
return fmt.Errorf("humanresources.hcmlink.company.list: %w", err)
}
var items []struct {
ID int `json:"id"`
Company string `json:"company"`
CrmCompanyID int `json:"crmCompanyId"`
Title string `json:"title"`
Data map[string]any `json:"data"`
CreatedAt string `json:"createdAt"`
Fields []map[string]any `json:"fields"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range items {
fmt.Println(item.ID, item.Company, item.Title)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"id": 15,
"company": "hr-company-001",
"crmCompanyId": 12,
"title": "ООО Ромашка",
"data": {
"inn": "1234567890"
},
"createdAt": "2026-08-06T19:51:02+03:00",
"fields": [
{
"field": "personal_number",
"title": "Табельный номер",
"type": "STRING",
"ttl": 86400
}
]
}
],
"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 |
Список компаний HCM Link (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Элемент массива result
|
Название |
Описание |
|
id |
Идентификатор компании HCM Link |
|
company |
Код компании в системе кадрового учета |
|
crmCompanyId |
Идентификатор компании CRM |
|
title |
Название компании |
|
data |
Дополнительные данные компании |
|
createdAt |
Дата создания в формате ISO 8601 |
|
fields |
Список полей компании (подробное описание) |
|
person |
Код физического лица в системе кадрового учета. Возвращается, если передан |
Элемент массива fields
|
Название |
Описание |
|
field |
Код поля в системе кадрового учета |
|
title |
Название поля |
|
type |
Тип поля. Возможные значения:
|
|
ttl |
Время жизни значения поля в секундах |
Обработка ошибок
HTTP-статус: 200, 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied! Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Когда возникает |
|
|
Operation failed |
Произошла ошибка получения списка компаний |
|
|
Access denied! Access denied. |
Пользователь не является администратором |
|
|
Application context required |
Метод вызван не в контексте приложения |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |