Get Employee By Id - Bindbee Docs

GET

api

hris

employees

{id}

Get Employee By 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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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"
  },
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "employee_number": "1",
  "company": "018af1fe-1250-772d-87c5-6f725a579e8a",
  "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": [
    "018af1fe-1250-772d-87c5-6f725a579e8a",
    "018af1fe-1250-772d-87c5-6f725a579e8b"
  ],
  "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": "018aeaff-cc7c-7837-988a-965762bd63c1",
  "pay_group": "018af1fe-1250-77c5-9fcd-4bca1e4568f4",
  "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": "018af1fe-1250-77c5-9fcd-4bca1e4568f4"
}

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

string<uuid>

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.

Example:

false

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

Example:

false

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.

Example:

"manager[first_name,last_name]"

Response

Successful Response

string<uuid>

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

modified_at

string

required

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

Example:

"2021-10-16T00:00:00Z"

custom_fields

Custom Fields · object

required

The custom fields related to the model

Example:

{
  "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"
}

raw_data

Raw Data · object

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}

employee_number

string | null

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

Example:

"1"

company

any | null

The ID of the employee's company.

Example:

"018af1fe-1250-772d-87c5-6f725a579e8a"

first_name

string | null

The employee's first name.

Example:

"Kunal"

middle_name

string | null

The employee's middle name.

Example:

"Christopher"

last_name

string | null

The employee's last name.

Example:

"Tyagi"

preferred_name

string | null

The employee's preferred first name.

Example:

"Dark Knight"

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.

Example:

"Kunal Tyagi"

username

string | null

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

Example:

"kunaltyagi"

designation

string | null

The employee's current designation/title

Example:

"Chief Technology Officer"

groups

any[] | null

The IDs of the groups that the employee belongs to.

Example:

[
  "018af1fe-1250-772d-87c5-6f725a579e8a",
  "018af1fe-1250-772d-87c5-6f725a579e8b"
]

department

string | null

The employee's department

Example:

"Engineering"

division

string | null

The employee's division

Example:

"Bangalore Division"

work_email

string | null

The employee's work email.

Example:

"kunal@bindbee.dev"

personal_email

string | null

The employee's personal email.

Example:

"kunaltyagi77@gmail.com"

mobile_phone_number

string | null

The employee's mobile phone number.

Example:

"+1234567890"

home_phone_number

string | null

The employee's home phone number.

Example:

"+1234567890"

country_code

string | null

The employee's country code

Example:

"+91"

home_location

HrisAddress · object

The employee's home address.

Show child attributes

Example:

{
  "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

HrisAddress · object

The employee's work address.

Show child attributes

Example:

{
  "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 | null

The employee ID of the employee's manager.

Example:

"018aeaff-cc7c-7837-988a-965762bd63c1"

pay_group

any | null

The employee's pay group

Example:

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

ssn

string | null

The employee's social security number.

Example:

"1234567890"

gender

enum<string>

The employee's gender. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:

MALE,

FEMALE,

NON-BINARY,

OTHER,

PREFER_NOT_TO_DISCLOSE,

-

Example:

"MALE"

ethnicity

enum<string>

The employee's ethnicity. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:

AMERICAN_INDIAN_OR_ALASKA_NATIVE,

ASIAN_OR_INDIAN_SUBCONTINENT,

BLACK_OR_AFRICAN_AMERICAN,

HISPANIC_OR_LATINO,

NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER,

TWO_OR_MORE_RACES,

WHITE,

PREFER_NOT_TO_DISCLOSE,

OTHER,

-

Example:

"ASIAN_OR_INDIAN_SUBCONTINENT"

marital_status

enum<string>

The employee's filing status as related to marital status. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:

SINGLE,

MARRIED,

DIVORCED,

SEPARATED,

COMMON_LAW,

DOMESTIC_PARTNERSHIP,

WIDOWED,

HEAD_OF_HOUSEHOLD,

QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD,

IN_A_RELATIONSHIP,

CIVIL_PARTNERSHIP,

OTHER,

-

Example:

"SINGLE"

date_of_birth

string | null

The employee's date of birth.

Example:

"1986-10-27T00:00:00Z"

start_date

string | null

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

Example:

"2023-03-05T00:00:00Z"

remote_created_at

string | null

When the third party's employee was created.

Example:

"2023-03-01T00:00:00Z"

employment_status

enum<string>

The employment status of the employee. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:

ACTIVE,

PENDING,

INACTIVE,

ACTIVE_EXTERNAL,

INACTIVE_EXTERNAL,

-,

LEAVE,

DECEASED,

RETIRED

Example:

"INACTIVE"

termination_date

string | null

The employee's termination date.

Example:

"2023-06-05T00:00:00Z"

avatar

string | null

The URL of the employee's avatar image.

Example:

"http://alturl.com/h2h8m"

payroll_run_calendar

any | null

The employee's payroll calendar

Example:

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

Get GroupsReturns a list of Group objects.

Get Employee By 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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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"
  },
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "employee_number": "1",
  "company": "018af1fe-1250-772d-87c5-6f725a579e8a",
  "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": [
    "018af1fe-1250-772d-87c5-6f725a579e8a",
    "018af1fe-1250-772d-87c5-6f725a579e8b"
  ],
  "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": "018aeaff-cc7c-7837-988a-965762bd63c1",
  "pay_group": "018af1fe-1250-77c5-9fcd-4bca1e4568f4",
  "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": "018af1fe-1250-77c5-9fcd-4bca1e4568f4"
}

Unified Models

Authorizations

Headers

Path Parameters

Query Parameters

Response