Batch Import API

Importing employees into UKG HR Service Delivery

This method is used to import employees into our system.

Warning

This endpoint entered deprecation in July 2021. As per our deprecation policy, its sunset period started in January 2022 and retirement will occur in July 2022. Consider using the corresponding APIv2 endpoint instead.

URL

POST /api/v1/import/employees/

Settings

Description of parameters

This POST call must be encoded in multipart/form-data. The POST parameter file contains the binary file:

file (mandatory):

Binary file of the document to be imported, CSV UTF-8 file. The format of this file is described here Employee synchronization

origin (optional): Character string, VARCHAR(10)

The origin of the request.

Possible values: api, sftp. Default: api

Response

Success

HTTP 201 Created: The import has been successful

Errors

HTTP 400 Bad Request: Invalid parameters.

List of errors in JSON format:

Each error is represented by its JSON object {'code': 1001, 'message': 'Invalid ...'}. The error message is given as an indication (debug).

  • code = 1408: mandatory parameter missing

  • code = 1409: the CSV file is not in UTF-8

  • code = 1410: the file is incomplete, it must include at least two lines: a header line and an import line

  • code = 1411: the origin is not valid. Possible values: api and sftp.

Example:

HTTP 400 Bad Request
{
  'code': 1409,
  'message': "The CSV file is not in UTF-8."
}

HTTP 403 Forbidden: Authentication failed.

Importing managers into UKG HR Service Delivery

This method is used to import managers into our system.

Warning

This endpoint entered deprecation in July 2021. As per our deprecation policy, its sunset period started in January 2022 and retirement will occur in July 2022. Consider using the corresponding APIv2 endpoint instead.

URL

POST /api/v1/import/managers/

Settings

Description of parameters

This POST call must be encoded in multipart/form-data. The POST parameter file contains the binary file:

file (mandatory):

Binary file of the document to be imported, CSV UTF-8 file. The file format is described here User profile synchronization

origin (optional): Character string, VARCHAR(10)

The origin of the request.

Possible values: api, sftp. Default: api

Response

Success

HTTP 201 Created: The import has been successful

Errors

HTTP 400 Bad Request: Invalid parameters.

List of errors in JSON format:

Each error is represented by its JSON object {'code': 1001, 'message': 'Invalid ...'}. The error message is given as an indication (debug).

  • code = 1408: mandatory parameter missing

  • code = 1409: the CSV file is not in UTF-8

  • code = 1410: the file is incomplete, it must include at least two lines: a header line and an import line

Example:

HTTP 400 Bad Request
{
  'code': 1409,
  'message': "The CSV file is not in UTF-8."
}

HTTP 403 Forbidden: Authentication failed.

Importing organizations into UKG HR Service Delivery

This method is used to import organizations into our system.

Warning

This endpoint entered deprecation in July 2021. As per our deprecation policy, its sunset period started in January 2022 and retirement will occur in July 2022. Consider using the corresponding APIv2 endpoint instead.

URL

POST /api/v1/import/organizations/

Settings

Description of parameters

This POST call must be encoded in multipart/form-data. The POST parameter file contains the binary file:

file (mandatory):

Binary file of the document to be imported, CSV UTF-8 file. The file format is described here Organization synchronization

origin (optional): Character string, VARCHAR(10)

The origin of the request.

Possible values: api, sftp. Default: api

Response

Success

HTTP 201 Created: The import has been successful

Errors

HTTP 400 Bad Request: Invalid parameters.

List of errors in JSON format:

Each error is represented by its JSON object {'code': 1001, 'message': 'Invalid ...'}. The error message is given as an indication (debug).

  • code = 1408: mandatory parameter missing

  • code = 1409: the CSV file is not in UTF-8

  • code = 1410: the file is incomplete, it must include at least two lines: a header line and an import line

Example:

HTTP 400 Bad Request
{
  'code': 1409,
  'message': "The CSV file is not in UTF-8."
}

HTTP 403 Forbidden: Authentication failed.