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

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

The Employee object is used to represent any person who has been employed by a company.

avatar
string | null
required

The URL of the employee's avatar image.

company
any | null
required

The ID of the employee's company.

custom_fields
object | null
required

The custom fields related to the model

date_of_birth
string | null
required

The employee's date of birth.

department
string | null
required

The employee's department

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.

division
string | null
required

The employee's division

employee_number
string | null
required

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

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.

ethnicity
string | null
required

The employee's ethnicity.

first_name
string | null
required

The employee's first name.

gender
string | null
required

The employee's gender.

groups
any[] | null
required

The IDs of the groups that the employee belongs to.

home_location
object | null
required

The employee's home address.

home_phone_number
string | null
required

The employee's home phone number.

id
string
required
last_name
string | null
required

The employee's last name.

marital_status
string | null
required

The employee's filing status as related to marital status

mobile_phone_number
string | null
required

The employee's mobile phone number.

modified_at
string
required

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

pay_group
any | null
required

The employee's pay group

payroll_run_calendar
any | null
required

The employee's payroll calendar

personal_email
string | null
required

The employee's personal email.

preferred_name
string | null
required

The employee's preferred first name.

remote_created_at
string | null
required

When the third party's employee was created.

remote_id
string | null
required

The third-party API ID of the matching object.

ssn
string | null
required

The employee's social security number.

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.

termination_date
string | null
required

The employee's termination date.

username
string | null
required

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

work_email
string | null
required

The employee's work email.

work_location
object | null
required

The employee's work address.

country_code
string | null

The employee's country code

designation
string | null

The employee's current designation/title

manager
any | null

The employee ID of the employee's manager.

middle_name
string | null

The employee's middle name.

raw_data
object | null

This is the Raw data