GET
/
api
/
hris
/
v1
/
employees
/
{id}
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employees/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "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": "<any>",
  "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>"
}

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

Path Parameters

id
string
required

Query Parameters

include_raw_data
boolean
default:
false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fields
boolean
default:
false

Whether to include custom fields in the response.

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Response

200
application/json
Successful Response
id
string
required
remote_id
string | null
required

The third-party API ID of the matching object.

modified_at
string
required

This is the datetime that this object was last updated by Bindbee

custom_fields
object | null
required

The custom fields related to the model

raw_data
object | null

This is the Raw data

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
any | null

The employee ID 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