Create Employee

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: <api-key>' \
  --data '
{
  "employee_number": "1",
  "company": "018af1fe-1250-772d-87c5-6f725a579e8a",
  "first_name": "Kunal",
  "middle_name": "Christopher",
  "last_name": "Tyagi",
  "preferred_name": "Dark Knight"
}
'

import requests

url = "https://api.bindbee.dev/api/hris/v1/employees"

payload = {
    "employee_number": "1",
    "company": "018af1fe-1250-772d-87c5-6f725a579e8a",
    "first_name": "Kunal",
    "middle_name": "Christopher",
    "last_name": "Tyagi",
    "preferred_name": "Dark Knight"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Connector-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    employee_number: '1',
    company: '018af1fe-1250-772d-87c5-6f725a579e8a',
    first_name: 'Kunal',
    middle_name: 'Christopher',
    last_name: 'Tyagi',
    preferred_name: 'Dark Knight'
  })
};

fetch('https://api.bindbee.dev/api/hris/v1/employees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/employees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'employee_number' => '1',
    'company' => '018af1fe-1250-772d-87c5-6f725a579e8a',
    'first_name' => 'Kunal',
    'middle_name' => 'Christopher',
    'last_name' => 'Tyagi',
    'preferred_name' => 'Dark Knight'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Connector-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/employees"

	payload := strings.NewReader("{\n  \"employee_number\": \"1\",\n  \"company\": \"018af1fe-1250-772d-87c5-6f725a579e8a\",\n  \"first_name\": \"Kunal\",\n  \"middle_name\": \"Christopher\",\n  \"last_name\": \"Tyagi\",\n  \"preferred_name\": \"Dark Knight\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bindbee.dev/api/hris/v1/employees")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employee_number\": \"1\",\n  \"company\": \"018af1fe-1250-772d-87c5-6f725a579e8a\",\n  \"first_name\": \"Kunal\",\n  \"middle_name\": \"Christopher\",\n  \"last_name\": \"Tyagi\",\n  \"preferred_name\": \"Dark Knight\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employee_number\": \"1\",\n  \"company\": \"018af1fe-1250-772d-87c5-6f725a579e8a\",\n  \"first_name\": \"Kunal\",\n  \"middle_name\": \"Christopher\",\n  \"last_name\": \"Tyagi\",\n  \"preferred_name\": \"Dark Knight\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

api

hris

employees

Create Employee

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: <api-key>' \
  --data '
{
  "employee_number": "1",
  "company": "018af1fe-1250-772d-87c5-6f725a579e8a",
  "first_name": "Kunal",
  "middle_name": "Christopher",
  "last_name": "Tyagi",
  "preferred_name": "Dark Knight"
}
'

import requests

url = "https://api.bindbee.dev/api/hris/v1/employees"

payload = {
    "employee_number": "1",
    "company": "018af1fe-1250-772d-87c5-6f725a579e8a",
    "first_name": "Kunal",
    "middle_name": "Christopher",
    "last_name": "Tyagi",
    "preferred_name": "Dark Knight"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Connector-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    employee_number: '1',
    company: '018af1fe-1250-772d-87c5-6f725a579e8a',
    first_name: 'Kunal',
    middle_name: 'Christopher',
    last_name: 'Tyagi',
    preferred_name: 'Dark Knight'
  })
};

fetch('https://api.bindbee.dev/api/hris/v1/employees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/employees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'employee_number' => '1',
    'company' => '018af1fe-1250-772d-87c5-6f725a579e8a',
    'first_name' => 'Kunal',
    'middle_name' => 'Christopher',
    'last_name' => 'Tyagi',
    'preferred_name' => 'Dark Knight'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Connector-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/employees"

	payload := strings.NewReader("{\n  \"employee_number\": \"1\",\n  \"company\": \"018af1fe-1250-772d-87c5-6f725a579e8a\",\n  \"first_name\": \"Kunal\",\n  \"middle_name\": \"Christopher\",\n  \"last_name\": \"Tyagi\",\n  \"preferred_name\": \"Dark Knight\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bindbee.dev/api/hris/v1/employees")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employee_number\": \"1\",\n  \"company\": \"018af1fe-1250-772d-87c5-6f725a579e8a\",\n  \"first_name\": \"Kunal\",\n  \"middle_name\": \"Christopher\",\n  \"last_name\": \"Tyagi\",\n  \"preferred_name\": \"Dark Knight\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employee_number\": \"1\",\n  \"company\": \"018af1fe-1250-772d-87c5-6f725a579e8a\",\n  \"first_name\": \"Kunal\",\n  \"middle_name\": \"Christopher\",\n  \"last_name\": \"Tyagi\",\n  \"preferred_name\": \"Dark Knight\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Usecases

Create an Employee - add a new employee to the customer’s HRIS, including the nested and integration-specific fields the platform requires

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

Authorization

string

header

default:<BINDBEE_API_KEY>

required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token

string

header

default:<CONNECTOR_TOKEN>

required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Headers

x-idempotency-key

string | null

Key to guarantee idempotent write execution.

Body

application/json

first_name

string

required

The employee's first name.

Example:

"Kunal"

last_name

string

required

The employee's last name.

Example:

"Tyagi"

start_date

string

required

The employee's start date in ISO 8601 format.

Example:

"2020-01-01"

pay_group

string<uuid>

required

Pay group for the following employee.

Example:

"018af1fe-1250-77c5-9fcd-4bca1e4568f4"

integration_params

ADPHrisEmployeeIntegrationParams · object

required

Parameters specific to the integration required for the write operation.

Show child attributes

Example:

{ "onBoardingTemplateCode": "12345" }

additional_attributes

Additional Attributes · object

Additional attributes that Bindbee doesn't supports but you might want to pass for the write operation.

Example:

{
  "notes": "The leave is approved by manager"
}

Response

Successful Response

API Basics

Platform

HR & Payroll (HRIS)

Recruiting (ATS)

Learning (LMS)

Create Employee

Step 1: Fetch the Required Request Body

Step 2: Create an Employee

Authorizations

Headers

Body

Response

​Step 1: Fetch the Required Request Body

​Step 2: Create an Employee

Authorizations

Headers

Body

Response

Step 1: Fetch the Required Request Body

Step 2: Create an Employee