Do take a look at Get Position Details API to fetch the list of Position IDs. You should pass the
id
of the corresponding position that pertains to your use case in thepositionId
key in this APIException: For apps that do not support the Get Position Details API but support this API , please pass in any dummy string as the
positionId
Supported Apps
Here are the list of apps that support this API.
Workday (workday)
- State must be an ISO 3166-2 code. Example: US-CA. Read more about it here: https://en.wikipedia.org/wiki/ISO_3166-2
- Country must be an ISO 3166-1 Alpha-3 code. Example: USA. Read more about it here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
Hibob (hibob)
-
Hibob only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored
-
workadress.id
corresponds to the Work Site in Hibob. To get the list of Work Sites available in Hibob, refer to this example: https://developers.getknit.dev/docs/hibob#get-list-of-work-sites-from-hibob -
The fields not supported by this API for Hibob are:
employment
->workShiftId
workAddress
->addressLine1, addressLine2, city, state, country, zipCode
For more information and request examples, refer to https://developers.getknit.dev/docs/hibob#create-an-employee
Sage (sage-hris)
Paychex (paychex)
Paylocity (paylocity)
Paycor (paycor)
- Paycor only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored
workaddress.id
corresponds to the Work Location in Paycor.- The fields not supported by this API for Personio are:
employment
->workshiftId
workAddress
->addressLine1, addressLine2, city, state, country, zipCode
\
You must include the following fields in the metadata
field:
PaygroupDescription
DepartmentCode
LegalEntityId
addressLine1
(This corresponds to the present address of the employee)zipCode
(This corresponds to the present address of the employee)
BambooHR (bamboohr)
-
BambooHR only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored
-
workadress.id
corresponds to the Work Location in BambooHR. To get the list of Work Sites available in BambooHR, refer to this example: https://developers.getknit.dev/docs/getting-started-with-bamboohr-api#get-list-of-work-locations-from-bamboohr -
The fields not supported by this API for Hibob are:
employment
->workShiftId
workAddress
->addressLine1, addressLine2, city, state, country, zipCode
For more information and request examples, refer to https://developers.getknit.dev/docs/getting-started-with-bamboohr-api#update-an-employee-details-api-in-bamboohr
Personio (personio)
-
workaddress.id
corresponds to the Office Location in Personio -
The fields not supported by this API for Personio are:
employment
->workshiftId
workAddress
->addressLine1, addressLine2, city, state, country, zipCode
personalEmails
For more information and request examples, refer to https://developers.getknit.dev/docs/getting-started-with-personio-hris-api#create-an-employee-in-personio-api
Darwinbox (darwinbox)
-
Darwinbox allows only one personal email per employee. If you pass more than one email in the personalEmails array, only the first will be taken, and the rest will be ignored
-
workAddress.id corresponds to the Office Location Work Area Code in Darwinbox.
-
You must include the following fields in the metadata field:
- Selfservice*
- Employee ID
- FTE Value*
Keka (keka)
-
workaddress.id
corresponds to the Location in Keka -
The fields not supported by this API for Keka are:
personalEmails
workAddress
->addressLine1, addressLine2, city, state, country, zipCode
-
You must include the following fields in the
metadata
field:gender
dateOfBirth
dateJoined
employeeNumber
(This is a user generated employee identifier eg, employee number, and is different from the internal identifier used by the app)department
businessUnit
Zoho People (zoho-people)
-
Zoho People only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored.
-
The fields not supported by this API for Zoho People are:
employment -> workShiftId
workAddress
-
You must include the following fields in the
metadata
field:employeeId
(This is a user generated employee identifier eg, employee number, and is different from the internal identifier used by the app)
SAP Successfactors (successfactors)
To know more about which parameters are supported and request examples, please refer to: https://developers.getknit.dev/docs/create-employee-api-sap-successfactors
Oracle Cloud HCM (oracle-hcm)
-
Oracle Cloud HCM only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored.
-
You must include the following fields in the
metadata
field:LegalEntityId
Remote (remote)
- The fields not supported by this API for Remote are:
personalEmails
employment
->workshiftId
- You must include the following fields in the
metadata
field:provisional_start_date
has_seniority_date
Humaans (humaans)
-
Humaans only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored.
-
The fields not supported by this API for Remote are:
employment
->workshiftId
workAddress
->addressLine1, addressLine2, city, state, country, zipCode
-
You must include the following fields in the
metadata
field:employmentStartDate
Breathe (breatheHR)
-
workaddress.id
corresponds to the Site. -
The fields not supported by this API for Breathe are:
employment
->workshiftId
personalEmails
workAddress
->addressLine1, addressLine2, city, state, country, zipCode
-
You must include the following fields in the
metadata
field:company_join_date
7shifts (7shifts)
You must include the following fields in the metadata
field:
departmentId
Alexis HR (alexishr)
PayFit (payfit)
workAddress
in knit payload corresponds to personalAddress
of a collaborator in PayFit
UKG Ready (ukgready)
IRIS Cascade (iriscascade)
People HR (peopleHR)
Kallidus (kallidus)
Folks HR (folkshr)
You must include the following fields in the metadata
field:
employeeNumber
(Unique identifier in the company.)
OneLogin (onelogin)
PrismHR (prismhr)
Refer api specific guides - PrismHR API Guide
Avionte (avionte)
ADP Workforce Now (adp-workforcenow-hris)
Namely (namely)
Lucca HR (luccahr)
Supported Request Fields:
firstName
lastName
employment.designation
workEmail
companyId
- Requireddepartment
- RequiredpersonalEmails
employeeNumber
startDate
birthDate
gender
phones.type
phones.phoneNumber
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode
manager.id
Supported Response Fields:
employeeId
TimeTac (timetac)
Supported Request Fields:
firstName
lastName
employeeNumber
workEmail
startDate
birthDate
phones
phones.type
phones.phoneNumber
department
- RequiredpresentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.country
presentAddress.zipCode
Additional Metadata:
internal_user_group
- Requiredlanguage_id
- Requiredusername
- Required- Any additional key-value pairs can be passed in metadata and will be forwarded to the TimeTac API
Supported Response Fields:
employeeId