v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified HRIS API

Create employee with form

Create an employee, based on the form schema.

<Note> This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes). </Note>

Example Request Body

{
  "staffing_entity_id": "26vafvWSRmbhNcxJYqjCzuJg",
  "properties": {
    "firstName": "John",
    "startDate": "2025-01-01",
    "workLocation": {
      "site": "8e422bf8cav",
      "keyNumbers": [
        142,
        525,
        63
      ]
    }
  }
}
post/hris/employees/form

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

staffing_entity_idstring
propertiesSchema3 required

Response

POST /hris/employees/form Positive response

status'success' required

Example response

{
  "data": {
    "id": "26vafvWSRmbhNcxJYqjCzuJg",
    "remote_id": "12345",
    "prehire": {
      "remote_id": null
    }
  }
}