Create Employee - Bindbee Docs

POST

api

hris

employees

curl --request POST \
  --url https://api.bindbee.dev/api/hris/v1/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-connector-token: <x-connector-token>' \
  --data '{
  "employee_number": "1",
  "company": "<any>",
  "first_name": "Kunal",
  "middle_name": "Christopher",
  "last_name": "Tyagi",
  "preferred_name": "Dark Knight",
  "display_full_name": "Kunal Tyagi",
  "username": "kunaltyagi",
  "designation": "Chief Technology Officer",
  "groups": [
    "<any>"
  ],
  "department": "Engineering",
  "division": "Bangalore Division",
  "work_email": "kunal@bindbee.dev",
  "personal_email": "kunaltyagi77@gmail.com",
  "mobile_phone_number": "+1234567890",
  "home_phone_number": "+1234567890",
  "country_code": "+91",
  "home_location": {
    "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"
  },
  "work_location": {
    "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"
  },
  "manager": "550e8400-e29b-41d4-a716-446655440000",
  "pay_group": "<any>",
  "ssn": "1234567890",
  "gender": "MALE",
  "ethnicity": "ASIAN_OR_INDIAN_SUBCONTINENT",
  "marital_status": "SINGLE",
  "date_of_birth": "1986-10-27T00:00:00Z",
  "start_date": "2023-03-05T00:00:00Z",
  "remote_created_at": "2023-03-01T00:00:00Z",
  "employment_status": "INACTIVE",
  "termination_date": "2023-06-05T00:00:00Z",
  "avatar": "http://alturl.com/h2h8m",
  "payroll_run_calendar": "<any>",
  "additional_attributes": {
    "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"
  },
  "custom_fields": {
    "customTshirtSize": "XXL"
  }
}'

{
  "success": true,
  "data": "<string>",
  "error": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token

string

required

Body

application/json

employee_number

string | null

The employee's number that appears in the third-party integration's UI.

company

any | null

The ID of the employee's company.

first_name

string | null

The employee's first name.

middle_name

string | null

The employee's middle name.

last_name

string | null

The employee's last name.

preferred_name

string | null

The employee's preferred first name.

display_full_name

string | null

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.

username

string | null

The employee's username that appears in the remote UI.

designation

string | null

The employee's current designation/title

groups

any[] | null

The IDs of the groups that the employee belongs to.

department

string | null

The employee's department

division

string | null

The employee's division

work_email

string | null

The employee's work email.

personal_email

string | null

The employee's personal email.

mobile_phone_number

string | null

The employee's mobile phone number.

home_phone_number

string | null

The employee's home phone number.

country_code

string | null

The employee's country code

home_location

object | null

The employee's home address.

work_location

object | null

The employee's work address.

manager

string | null

UUID of the employee's manager

pay_group

any | null

The employee's pay group

ssn

string | null

The employee's social security number.

gender

string | null

The employee's gender.

ethnicity

string | null

The employee's ethnicity.

marital_status

string | null

The employee's filing status as related to marital status

date_of_birth

string | null

The employee's date of birth.

start_date

string | null

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_at

string | null

When the third party's employee was created.

employment_status

string | null

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.

termination_date

string | null

The employee's termination date.

avatar

string | null

The URL of the employee's avatar image.

payroll_run_calendar

any | null

The employee's payroll calendar

additional_attributes

object | null

Fields related to models other than employee Model

custom_fields

object | null

The custom fields related to the model

Response

200

application/json

Successful Response

success

boolean

required

data

string

required

error

object | null

Get Create Employee Request Body Get Employee By Id

curl --request POST \
  --url https://api.bindbee.dev/api/hris/v1/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-connector-token: <x-connector-token>' \
  --data '{
  "employee_number": "1",
  "company": "<any>",
  "first_name": "Kunal",
  "middle_name": "Christopher",
  "last_name": "Tyagi",
  "preferred_name": "Dark Knight",
  "display_full_name": "Kunal Tyagi",
  "username": "kunaltyagi",
  "designation": "Chief Technology Officer",
  "groups": [
    "<any>"
  ],
  "department": "Engineering",
  "division": "Bangalore Division",
  "work_email": "kunal@bindbee.dev",
  "personal_email": "kunaltyagi77@gmail.com",
  "mobile_phone_number": "+1234567890",
  "home_phone_number": "+1234567890",
  "country_code": "+91",
  "home_location": {
    "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"
  },
  "work_location": {
    "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"
  },
  "manager": "550e8400-e29b-41d4-a716-446655440000",
  "pay_group": "<any>",
  "ssn": "1234567890",
  "gender": "MALE",
  "ethnicity": "ASIAN_OR_INDIAN_SUBCONTINENT",
  "marital_status": "SINGLE",
  "date_of_birth": "1986-10-27T00:00:00Z",
  "start_date": "2023-03-05T00:00:00Z",
  "remote_created_at": "2023-03-01T00:00:00Z",
  "employment_status": "INACTIVE",
  "termination_date": "2023-06-05T00:00:00Z",
  "avatar": "http://alturl.com/h2h8m",
  "payroll_run_calendar": "<any>",
  "additional_attributes": {
    "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"
  },
  "custom_fields": {
    "customTshirtSize": "XXL"
  }
}'

{
  "success": true,
  "data": "<string>",
  "error": {}
}

Unified Models

Authorizations

Headers

Body

Response