BIbindbee
Employee

Get Employee By Id

Changed on

Returns an Employee object with the given id.

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

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employee_numberstring nullable

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

companystring nullable

The ID of the employee's company.

first_namestring nullable

The employee's first name.

middle_namestring nullable

The employee's middle name.

last_namestring nullable

The employee's last name.

preferred_namestring nullable

The employee's preferred first name.

display_full_namestring nullable

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.

usernamestring nullable

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

designationstring nullable

The employee's current designation/title

departmentstring nullable

The employee's department

divisionstring nullable

The employee's division

work_emailstring nullable

The employee's work email.

personal_emailstring nullable

The employee's personal email.

mobile_phone_numberstring nullable

The employee's mobile phone number.

home_phone_numberstring nullable

The employee's home phone number.

country_codestring nullable

The employee's country code

managerstring nullable

The employee ID of the employee's manager.

pay_groupstring nullable

The employee's pay group

ssnstring nullable

The employee's social security number.

genderstring nullable

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

ethnicitystring nullable

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

marital_statusstring nullable

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.

tobacco_useboolean nullable

Indicates whether the employee uses tobacco or is a smoker.

date_of_birthstring nullable

The employee's date of birth.

start_datestring nullable

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

remote_created_atstring nullable

When the third party's employee was created.

employment_statusstring nullable

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.

termination_datestring nullable

The employee's termination date.

termination_reasonstring nullable

The employee's termination reason.

avatarstring nullable

The URL of the employee's avatar image.

payroll_run_calendarstring nullable

The employee's payroll calendar

employment_typestring nullable

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

Example response

{
  "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": "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": {
    "name": "UK-HO-London",
    "location": "UK-HO-London",
    "street_1": "1011",
    "street_2": "Lane number 4, Golden Villa",
    "city": "London",
    "state": "LND",
    "postal_code": "56273",
    "country": "UK"
  },
  "work_location": {
    "name": "UK-HO-London",
    "location": "UK-HO-London",
    "street_1": "1011",
    "street_2": "Lane number 4, Golden Villa",
    "city": "London",
    "state": "LND",
    "postal_code": "56273",
    "country": "UK"
  },
  "work_locations": [
    "018af1fe-1250-772d-87c5-6f725a579e8a",
    "018af1fe-1250-772d-87c5-6f725a579e8b"
  ],
  "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",
  "tobacco_use": true,
  "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",
  "termination_reason": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
  "avatar": "http://alturl.com/h2h8m",
  "payroll_run_calendar": "018af1fe-1250-77c5-9fcd-4bca1e4568f4",
  "employment_type": "FULL_TIME"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      added the optional property to the response with the status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the ACTIVE enum value from the response property for the response status

    • info

      removed the ACTIVE_EXTERNAL enum value from the response property for the response status

    • info

      removed the AMERICAN_INDIAN_OR_ALASKA_NATIVE enum value from the response property for the response status

    • info

      removed the ASIAN_OR_INDIAN_SUBCONTINENT enum value from the response property for the response status

    • info

      removed the BLACK_OR_AFRICAN_AMERICAN enum value from the response property for the response status

    • info

      removed the CIVIL_PARTNERSHIP enum value from the response property for the response status

    • info

      removed the COMMON_LAW enum value from the response property for the response status

    • info

      removed the DECEASED enum value from the response property for the response status

    • info

      removed the DIVORCED enum value from the response property for the response status

    • info

      removed the DOMESTIC_PARTNERSHIP enum value from the response property for the response status

    • info

      removed the FEMALE enum value from the response property for the response status

    • info

      removed the HEAD_OF_HOUSEHOLD enum value from the response property for the response status

    • info

      removed the HISPANIC_OR_LATINO enum value from the response property for the response status

    • info

      removed the INACTIVE enum value from the response property for the response status

    • info

      removed the INACTIVE_EXTERNAL enum value from the response property for the response status

    • info

      removed the IN_A_RELATIONSHIP enum value from the response property for the response status

    • info

      removed the LEAVE enum value from the response property for the response status

    • info

      removed the MALE enum value from the response property for the response status

    • info

      removed the MARRIED enum value from the response property for the response status

    • info

      removed the NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER enum value from the response property for the response status

    • info

      removed the NON-BINARY enum value from the response property for the response status

    • info

      removed the OTHER enum value from the response property for the response status

    • info

      removed the OTHER enum value from the response property for the response status

    • info

      removed the OTHER enum value from the response property for the response status

    • info

      removed the PENDING enum value from the response property for the response status

    • info

      removed the PREFER_NOT_TO_DISCLOSE enum value from the response property for the response status

    • info

      removed the PREFER_NOT_TO_DISCLOSE enum value from the response property for the response status

    • info

      removed the QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD enum value from the response property for the response status

    • info

      removed the RETIRED enum value from the response property for the response status

    • info

      removed the SEPARATED enum value from the response property for the response status

    • info

      removed the SINGLE enum value from the response property for the response status

    • info

      removed the TWO_OR_MORE_RACES enum value from the response property for the response status

    • info

      removed the WHITE enum value from the response property for the response status

    • info

      removed the WIDOWED enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API