Get HCM Link Job Status humanresources.hcmlink.job.status.get
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.hcmlinkWho can execute the method: administrator
The humanresources.hcmlink.job.status.get method checks whether an HCM Link synchronization job is active.
The method can only be executed in the context of authorization of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Synchronization job ID. The ID is passed in the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":101,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/humanresources.hcmlink.job.status.get
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.job.status.get',
params: {
id: 101,
},
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 getHcmLinkJobStatus() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'humanresources.hcmlink.job.status.get',
params: {
id: 101
},
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', getHcmLinkJobStatus)
</script>
try {
$response = $b24Service
->core
->call(
'humanresources.hcmlink.job.status.get',
[
'id' => 101,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting job status: ' . $e->getMessage();
}
BX24.callMethod(
'humanresources.hcmlink.job.status.get',
{
id: 101
},
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.job.status.get',
[
'id' => 101,
]
);
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.job.status.get", b24.Params{
"id": 101,
})
if err != nil {
return fmt.Errorf("humanresources.hcmlink.job.status.get: %w", err)
}
var result struct {
Alive bool `json:"alive"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("response breakdown: %w", err)
}
fmt.Println(result.Alive)
Response Handling
HTTP status: 200
{
"result": {
"alive": true
},
"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 |
Description |
|
result |
Job state information |
|
time |
Request execution time information |
result Object Fields
|
Name |
Description |
|
alive |
Active job flag. Returns |
Error Handling
HTTP status: 200, 403
{
"error": 0,
"error_description": "Operation failed"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Operation failed |
The job was not found |
|
|
Access denied! Access denied. |
The user is not an administrator |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |