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

      Forms API

      This article provides you with the APIs for Form requests.

      GET /xEmployee/:employeeId/form/:formInternalName/:formID

      Get one form for an employee.

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/475edc1d1b1a31ccdbdc94b398d5910d/form/ITAcknowledgment/8320fb07077a2935

      Response

      Status: 200 OK

      GET /xEmployee/:employeeId/forms

      Get all forms for an employee.

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/475edc1d1b1a31ccdbdc94b398d5910d/forms

      Response

      Status: 200 OK

       

      GET /xEmployee/:employeeId/forms/download/:formInternalName_:formID

      Download one form from an employee.

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/475edc1d1b1a31ccdbdc94b398d5910d/forms/download/ITAcknowledgment_8320fb07077a2935

      Response

      Status: 200 OK

      The response content is a file stream in zip format containing one specific file belonging to that employee

      GET /xEmployee/:employeeId/forms/download/:formInternalName1_:formID1,:formInternalName2_:formID2...

      Download multiple forms from an employee.

      The form Internal Names and Ids are separated by comma(,)

      Request Example

      GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/475edc1d1b1a31ccdbdc94b398d5910d/forms/download/ITAcknowledgment_8320fb07077a2935,W4_4550xa07077a2935

      Response

      Status: 200 OK

      The response content is a file stream in zip format containing multiple forms belonging to that employee

      GET /xEmployee/:employeeId/forms/download

      Download all forms from an employee.

      Request Example

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

      Response

      Status: 200 OK

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