Get the form for creating an employee. This form can be rendered dynamically on your frontend to allow your customers to create employees in their HRIS.
curl --request GET \
--url https://api.kombo.dev/v1/hris/employees/form \
--header 'Authorization: Bearer <token>' \
--header 'X-Integration-Id: <x-integration-id>'
{
"status": "success",
"data": {
"properties": {
"firstName": {
"label": "First Name",
"required": true,
"description": "Employee's first name",
"unified_key": "first_name",
"type": "text",
"min_length": 1,
"max_length": 100
},
"startDate": {
"label": "Start Date",
"required": true,
"description": "Employee's start date",
"unified_key": "start_date",
"type": "date"
},
"workLocation": {
"label": "Work Location",
"required": false,
"description": "Employee's work location",
"unified_key": null,
"type": "object",
"properties": {
"site": {
"label": "Site",
"required": true,
"description": "Employee's site",
"unified_key": null,
"type": "single_select",
"options": {
"type": "inline",
"entries": [
{
"id": "FXrER44xubBqA9DLgZ3PFNNx",
"label": "Site 1",
"unified_value": "1"
},
{
"id": "2rv75UKT2XBoQXsUb9agiTUm",
"label": "Site 2",
"unified_value": "2"
}
]
}
},
"keyNumbers": {
"label": "Key Numbers",
"required": false,
"description": "Employee's key numbers",
"unified_key": null,
"type": "array",
"item_type": {
"label": "Key Number",
"required": false,
"description": "The number of the keys which belong to the employee",
"unified_key": null,
"type": "number",
"min": 0,
"max": 99
},
"min_items": 2,
"max_items": 5
}
}
}
}
}
}
Follow our create employee guide here to learn how this form is generated and how you can use it.
{
"properties": {
"firstName": {
"type": "text",
"label": "First Name",
"required": true,
"description": "Employee's first name",
"unified_key": "first_name",
"min_length": 1,
"max_length": 100
},
"startDate": {
"type": "date",
"label": "Start Date",
"required": true,
"description": "Employee's start date",
"unified_key": "start_date"
},
"workLocation": {
"type": "object",
"label": "Work Location",
"required": false,
"description": "Employee's work location",
"unified_key": null,
"properties": {
"site": {
"type": "single_select",
"label": "Site",
"required": true,
"description": "Employee's site",
"unified_key": null,
"options": {
"type": "inline",
"entries": [
{
"label": "Site 1",
"id": "FXrER44xubBqA9DLgZ3PFNNx",
"unified_value": "1"
},
{
"label": "Site 2",
"id": "2rv75UKT2XBoQXsUb9agiTUm",
"unified_value": "2"
}
]
}
},
"keyNumbers": {
"type": "array",
"label": "Key Numbers",
"required": false,
"description": "Employee's key numbers",
"unified_key": null,
"min_items": 2,
"max_items": 5,
"item_type": {
"type": "number",
"label": "Key Number",
"required": false,
"description": "The number of the keys which belong to the employee",
"unified_key": null,
"min": 0,
"max": 99
}
}
}
}
}
}
ID of the integration you want to interact with.
GET /hris/employees/form Positive response
The response is of type object
.
curl --request GET \
--url https://api.kombo.dev/v1/hris/employees/form \
--header 'Authorization: Bearer <token>' \
--header 'X-Integration-Id: <x-integration-id>'
{
"status": "success",
"data": {
"properties": {
"firstName": {
"label": "First Name",
"required": true,
"description": "Employee's first name",
"unified_key": "first_name",
"type": "text",
"min_length": 1,
"max_length": 100
},
"startDate": {
"label": "Start Date",
"required": true,
"description": "Employee's start date",
"unified_key": "start_date",
"type": "date"
},
"workLocation": {
"label": "Work Location",
"required": false,
"description": "Employee's work location",
"unified_key": null,
"type": "object",
"properties": {
"site": {
"label": "Site",
"required": true,
"description": "Employee's site",
"unified_key": null,
"type": "single_select",
"options": {
"type": "inline",
"entries": [
{
"id": "FXrER44xubBqA9DLgZ3PFNNx",
"label": "Site 1",
"unified_value": "1"
},
{
"id": "2rv75UKT2XBoQXsUb9agiTUm",
"label": "Site 2",
"unified_value": "2"
}
]
}
},
"keyNumbers": {
"label": "Key Numbers",
"required": false,
"description": "Employee's key numbers",
"unified_key": null,
"type": "array",
"item_type": {
"label": "Key Number",
"required": false,
"description": "The number of the keys which belong to the employee",
"unified_key": null,
"type": "number",
"min": 0,
"max": 99
},
"min_items": 2,
"max_items": 5
}
}
}
}
}
}
Get the form for creating an employee. This form can be rendered dynamically on your frontend to allow your customers to create employees in their HRIS.
curl --request GET \
--url https://api.kombo.dev/v1/hris/employees/form \
--header 'Authorization: Bearer <token>' \
--header 'X-Integration-Id: <x-integration-id>'
{
"status": "success",
"data": {
"properties": {
"firstName": {
"label": "First Name",
"required": true,
"description": "Employee's first name",
"unified_key": "first_name",
"type": "text",
"min_length": 1,
"max_length": 100
},
"startDate": {
"label": "Start Date",
"required": true,
"description": "Employee's start date",
"unified_key": "start_date",
"type": "date"
},
"workLocation": {
"label": "Work Location",
"required": false,
"description": "Employee's work location",
"unified_key": null,
"type": "object",
"properties": {
"site": {
"label": "Site",
"required": true,
"description": "Employee's site",
"unified_key": null,
"type": "single_select",
"options": {
"type": "inline",
"entries": [
{
"id": "FXrER44xubBqA9DLgZ3PFNNx",
"label": "Site 1",
"unified_value": "1"
},
{
"id": "2rv75UKT2XBoQXsUb9agiTUm",
"label": "Site 2",
"unified_value": "2"
}
]
}
},
"keyNumbers": {
"label": "Key Numbers",
"required": false,
"description": "Employee's key numbers",
"unified_key": null,
"type": "array",
"item_type": {
"label": "Key Number",
"required": false,
"description": "The number of the keys which belong to the employee",
"unified_key": null,
"type": "number",
"min": 0,
"max": 99
},
"min_items": 2,
"max_items": 5
}
}
}
}
}
}
Follow our create employee guide here to learn how this form is generated and how you can use it.
{
"properties": {
"firstName": {
"type": "text",
"label": "First Name",
"required": true,
"description": "Employee's first name",
"unified_key": "first_name",
"min_length": 1,
"max_length": 100
},
"startDate": {
"type": "date",
"label": "Start Date",
"required": true,
"description": "Employee's start date",
"unified_key": "start_date"
},
"workLocation": {
"type": "object",
"label": "Work Location",
"required": false,
"description": "Employee's work location",
"unified_key": null,
"properties": {
"site": {
"type": "single_select",
"label": "Site",
"required": true,
"description": "Employee's site",
"unified_key": null,
"options": {
"type": "inline",
"entries": [
{
"label": "Site 1",
"id": "FXrER44xubBqA9DLgZ3PFNNx",
"unified_value": "1"
},
{
"label": "Site 2",
"id": "2rv75UKT2XBoQXsUb9agiTUm",
"unified_value": "2"
}
]
}
},
"keyNumbers": {
"type": "array",
"label": "Key Numbers",
"required": false,
"description": "Employee's key numbers",
"unified_key": null,
"min_items": 2,
"max_items": 5,
"item_type": {
"type": "number",
"label": "Key Number",
"required": false,
"description": "The number of the keys which belong to the employee",
"unified_key": null,
"min": 0,
"max": 99
}
}
}
}
}
}
ID of the integration you want to interact with.
GET /hris/employees/form Positive response
The response is of type object
.
curl --request GET \
--url https://api.kombo.dev/v1/hris/employees/form \
--header 'Authorization: Bearer <token>' \
--header 'X-Integration-Id: <x-integration-id>'
{
"status": "success",
"data": {
"properties": {
"firstName": {
"label": "First Name",
"required": true,
"description": "Employee's first name",
"unified_key": "first_name",
"type": "text",
"min_length": 1,
"max_length": 100
},
"startDate": {
"label": "Start Date",
"required": true,
"description": "Employee's start date",
"unified_key": "start_date",
"type": "date"
},
"workLocation": {
"label": "Work Location",
"required": false,
"description": "Employee's work location",
"unified_key": null,
"type": "object",
"properties": {
"site": {
"label": "Site",
"required": true,
"description": "Employee's site",
"unified_key": null,
"type": "single_select",
"options": {
"type": "inline",
"entries": [
{
"id": "FXrER44xubBqA9DLgZ3PFNNx",
"label": "Site 1",
"unified_value": "1"
},
{
"id": "2rv75UKT2XBoQXsUb9agiTUm",
"label": "Site 2",
"unified_value": "2"
}
]
}
},
"keyNumbers": {
"label": "Key Numbers",
"required": false,
"description": "Employee's key numbers",
"unified_key": null,
"type": "array",
"item_type": {
"label": "Key Number",
"required": false,
"description": "The number of the keys which belong to the employee",
"unified_key": null,
"type": "number",
"min": 0,
"max": 99
},
"min_items": 2,
"max_items": 5
}
}
}
}
}
}