Skip to main content
POST
/
hris
/
employees
/
form
TypeScript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.hris.createEmployeeWithForm({
    properties: {
      "firstName": "John",
      "startDate": "2025-01-01T00:00:00Z",
      "workLocation": {
        "site": "8e422bf8cav",
        "keyNumbers": {
          "0": 142,
          "1": 525,
          "2": 63,
        },
      },
    },
  });

  console.log(result);
}

run();
{
  "status": "success",
  "data": {
    "id": "26vafvWSRmbhNcxJYqjCzuJg",
    "remote_id": "12345",
    "prehire": {
      "remote_id": null
    }
  },
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}
This endpoint requires the permission Create and manage employees to be enabled in your scope config.

​
Example Request Body

{
  "properties": {
    "firstName": "John",
    "startDate": "2025-01-01",
    "workLocation": {
      "site": "8e422bf8cav",
      "keyNumbers": [
        142,
        525,
        63
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Body

application/json

POST /hris/employees/form Request body

​
properties
object
required

Response

POST /hris/employees/form Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "id": "26vafvWSRmbhNcxJYqjCzuJg",
  "remote_id": "12345",
  "prehire": { "remote_id": null }
}
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.