Create Employee
Creates an Employee object with the given values.
To create an employee in HRIS, you first need to fetch the request body structure that HRIS expects. This structure varies based on the HRIS provider (e.g., BambooHR, ADP, Workday). The request body consists of three parts:
- Model Keys: Standard attributes required for all employees.
- Additional Attributes: Specific fields required by the chosen HRIS.
- Custom Fields: Extra metadata for specific implementations.
Note: Some attributes may have allowed_values, meaning only specific values are permitted based on the customer’s HRIS configuration. Ensure you check for these constraints before submitting the request.
Step 1: Fetch the Required Request Body
Before calling the Create Employee API, you need to get the request structure using the Meta Create Employee API.
Step 2: Create an Employee
Once you have the request body structure, use the Create Employee API to send the request.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
The employee's number that appears in the third-party integration's UI.
"1"
The ID of the employee's company.
The employee's first name.
"Kunal"
The employee's middle name.
"Christopher"
The employee's last name.
"Tyagi"
The employee's preferred first name.
"Dark Knight"
The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.
"Kunal Tyagi"
The employee's username that appears in the remote UI.
"kunaltyagi"
The employee's current designation/title
"Chief Technology Officer"
The IDs of the groups that the employee belongs to.
The employee's department
"Engineering"
The employee's division
"Bangalore Division"
The employee's work email.
"kunal@bindbee.dev"
The employee's personal email.
"kunaltyagi77@gmail.com"
The employee's mobile phone number.
"+1234567890"
The employee's home phone number.
"+1234567890"
The employee's country code
"+91"
The employee's home address.
{
"city": "London",
"country": "UK",
"location": "UK-HO-London",
"name": "UK-HO-London",
"postal_code": "56273",
"state": "LND",
"street_1": "1011",
"street_2": "Lane number 4, Golden Villa"
}
The employee's work address.
{
"city": "London",
"country": "UK",
"location": "UK-HO-London",
"name": "UK-HO-London",
"postal_code": "56273",
"state": "LND",
"street_1": "1011",
"street_2": "Lane number 4, Golden Villa"
}
UUID of the employee's manager
"550e8400-e29b-41d4-a716-446655440000"
The employee's pay group
"018af1fe-1250-77c5-9fcd-4bca1e4568f4"
The employee's social security number.
"1234567890"
The employee's gender.
"MALE"
The employee's ethnicity.
"ASIAN_OR_INDIAN_SUBCONTINENT"
The employee's filing status as related to marital status
"SINGLE"
The employee's date of birth.
"1986-10-27T00:00:00Z"
The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
"2023-03-05T00:00:00Z"
When the third party's employee was created.
"2023-03-01T00:00:00Z"
The employment status of the employee. Possible values include: ACTIVE, PENDING, INACTIVE, or - in cases where there is no clear mapping - the original value passed through.
"INACTIVE"
The employee's termination date.
"2023-06-05T00:00:00Z"
The URL of the employee's avatar image.
"http://alturl.com/h2h8m"
The employee's payroll calendar
Fields related to models other than employee Model
{
"contract_end_date": "2025-12-31T00:00:00",
"emergency_contact": "John Doe - +1-234-567-8901",
"employee_type": "Contract",
"language_proficiency": "English, French",
"marital_status": "Married",
"performance_rating": "Excellent",
"previous_employer": "TechCorp"
}
The custom fields related to the model
{ "customTshirtSize": "XXL" }