API Reference
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#BAMBOO_HR_CREATE_EMPLOYEE' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "BAMBOO_HR_CREATE_EMPLOYEE",
"parameters": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"employeeNumber": "<string>",
"gender": "<string>",
"socialSecurity": "<string>",
"maritalStatus": "<string>",
"hireDate": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"employmentHistory": "contractor",
"exempt": "exempt",
"payType": "hourly",
"payRate": "<string>",
"payPer": "hour",
"location": "<string>",
"department": "<string>",
"division": "<string>",
"additionalFields": {}
}
}
'Create Employee
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#BAMBOO_HR_CREATE_EMPLOYEE' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "BAMBOO_HR_CREATE_EMPLOYEE",
"parameters": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"employeeNumber": "<string>",
"gender": "<string>",
"socialSecurity": "<string>",
"maritalStatus": "<string>",
"hireDate": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"employmentHistory": "contractor",
"exempt": "exempt",
"payType": "hourly",
"payRate": "<string>",
"payPer": "hour",
"location": "<string>",
"department": "<string>",
"division": "<string>",
"additionalFields": {}
}
}
'Authorizations
Your Paragon User Token (JWT), which you can generate using your project's signing keys.
Path Parameters
Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.
Body
Show child attributes
Show child attributes
First Name : Specify the first name of the employee to create. (example: "John")
Last Name : Specify the last name of the employee to create. (example: "Doe")
Date of Birth (example: "yyyy-mm-dd")
Employee Number (example: "5")
Gender : Specify the plain text name of the gender.
Social Security Number : Specify the social security number of the employee to create.
Marital Status : Specify the plain text status of marriage. (example: "Single")
Hire Date : Specify the date of hire for the employee to create. (example: "yyyy-mm-dd")
Address Line 1 (example: "2000 Oak Street")
City (example: "San Francisco")
State : Specify the full name of the state or province. (example: "California")
Country : Specify the name of the country. Must exist in the BambooHR country list. (example: "United States")
Employment History Status : The employee's employment status as used to filter employees in BambooHR.
contractor, full-time, furloughed, intern, part-time, terminated Exempt : Specify the FLSA Overtime Status of the employee.
exempt, non exempt Pay Type : Specify the employee’s current pay type.
hourly, salary, commision, exception hourly, monthly, piece rate, contract, daily, pro rata Pay Rate : Specify the employee’s current pay rate. (example: "8.25")
Pay Per : Specify the employee’s current pay per.
hour, day, week, month, quater, year Location : Specify the employee's current location. The provided location must exist in the BambooHR instance’s location table.
Department : Specify the employee's current department. The provided department must exist in the BambooHR instance’s department table.
Division : Specify the employee's current division. The provided division must exist in the BambooHR instance’s division table.
Additional Fields (example: "{ jobTitle: "Accountant", nickname: "John", address2: "Seattle" }")
Response
Success
Was this page helpful?