Document
      Back to home
      1. Help Center
      2. HR Cloud API
      3. Document

      Documents API

      This article provides you with the APIs for Documents requests.

      GET /xEmployee/:employeeId/attachments/:attachmentId

      Get one attachment of an employee.

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/42207b4aefd32d9c9219453bdf988623/attachments/692affafc7c3b321dd43e63f2c9e5d84

      Response

      Status: 200 OK

      POST /xEmployee/:employeeId/attachments

      Create an attachment for an employee.

      Request Example

      Request Body Content Type must be multipart/form-data

      POST https://corehr-api.hrcloud.com/v1/cloud/xEmployee/42207b4aefd32d9c9219453bdf988623/attachments

      Response

      Status: 200 OK

      DELETE /xEmployee/:employeeId/attachments/:attachmentId

      Delete an attachment from an employee.

      Request Example

      DELETE https://corehr-api.hrcloud.com/v1/cloud/xEmployee/42207b4aefd32d9c9219453bdf988623/attachments/692affafc7c3b321dd43e63f2c9e5d84

      Response

      Status: 200 OK

      GET /xEmployee/:employeeId/attachments/download

      Download ALL attachments from an employee.

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/42207b4aefd32d9c9219453bdf988623/attachments/download

      Response

      Status: 200 OK

      The response content is a file stream in zip format that containing all files belonging to that employee

      GET /xEmployee/:employeeId/attachments/download/:attachmentId1,:attachmentId2,...

      Download some attachments from an employee.

      The attachment Ids are separated by comma(,)

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/42207b4aefd32d9c9219453bdf988623/attachments/download/692affafc7c3b321dd43e63f2c9e5d84,892affa5k7c3b321dd43e63f2c9e5d84

      Response

      Status: 200 OK

      The response content is a file stream in zip format that containing some files belonging to that employee

      GET /xEmployee/:employeeId/attachments/download/:attachmentId

      Download one attachment from an employee.

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/42207b4aefd32d9c9219453bdf988623/attachments/download/692affafc7c3b321dd43e63f2c9e5d84

      Response

      Status: 200 OK

      The response content is a file stream content belonging to that employee