GET
/
api
/
hris
/
v1
/
employees
/
{id}

Authorizations

Authorization
string
headerrequired

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.

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Response

200 - application/json
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

raw_data
object | null

This is the Raw data

employee_number
string | null
required

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

company
string | null
required

The ID of the employee's company.

first_name
string | null
required

The employee's first name.

middle_name
string | null

The employee's middle name.

last_name
string | null
required

The employee's last name.

preferred_name
string | null
required

The employee's preferred first name.

display_full_name
string | null
required

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
required

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

designation
string | null

The employee's current designation/title

groups
string[] | null
required

The IDs of the groups that the employee belongs to.

department
string | null
required

The employee's department

division
string | null
required

The employee's division

work_email
string | null
required

The employee's work email.

personal_email
string | null
required

The employee's personal email.

mobile_phone_number
string | null
required

The employee's mobile phone number.

home_phone_number
string | null
required

The employee's home phone number.

country_code
string | null

The employee's country code

home_location
object | null
required

The employee's home address.

work_location
object | null
required

The employee's work address.

manager
any | null

The employee ID of the employee's manager.

pay_group
string | null
required

The employee's pay group

ssn
string | null
required

The employee's social security number.

gender
string | null
required

The employee's gender.

ethnicity
string | null
required

The employee's ethnicity.

marital_status
string | null
required

The employee's filing status as related to marital status

date_of_birth
string | null
required

The employee's date of birth.

start_date
string | null
required

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
required

When the third party's employee was created.

employment_status
string | null
required

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
default: The employee's termination date.
avatar
string | null
default: The URL of the employee's avatar image.