Get HCM Link Job Status humanresources.hcmlink.job.status.get

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.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
type

Description

id*
integer

Synchronization job ID.

The ID is passed in the jobId field of the OnHumanResourcesHcmLinkEmployeeListRequested, OnHumanResourcesHcmLinkFieldValueRequested, OnHumanResourcesHcmLinkEmployeeListMapped, OnHumanResourcesHcmLinkPinRequested, or OnHumanResourcesHcmLinkSalaryVacationRequested events

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

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 `type`	Description
result `object`	Job state information
time `time`	Request execution time information

result Object Fields

Name `type`	Description
alive `boolean`	Active job flag. Returns `true` if the job is not completed

Error Handling

HTTP status: 200, 403

{
            "error": 0,
            "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
`0`	Operation failed	The job was not found
`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

Was the article helpful?

Update Synchronization Job

Overview of Methods

Get HCM Link Job Status humanresources.hcmlink.job.status.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

result Object Fieldsresult Object Fields

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning