--- title: "Get Employee By Id" method: GET path: "/api/hris/v1/employees/{id}" tags: ["Employee"] --- # Get Employee By Id `GET /api/hris/v1/employees/{id}` Returns an Employee object with the given id. ## Path parameters - `id` string, uuid, required ## Query parameters - `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models. - `include_custom_fields` boolean — 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. ## Headers - `x-connector-token` string, required ## Response `200` Successful Response - HrisEmployeeResponse - `id` string, uuid, required - `remote_id` string, nullable, 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, nullable — This is the Raw data - `custom_fields` object, nullable, required — The custom fields related to the model - `employee_number` string, nullable — The employee's number that appears in the third-party integration's UI. - `company` string, nullable — The ID of the employee's company. - `first_name` string, nullable — The employee's first name. - `middle_name` string, nullable — The employee's middle name. - `last_name` string, nullable — The employee's last name. - `preferred_name` string, nullable — The employee's preferred first name. - `display_full_name` string, 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. - `username` string, nullable — The employee's username that appears in the remote UI. - `designation` string, nullable — The employee's current designation/title - `groups` unknown[], nullable — The IDs of the groups that the employee belongs to. - unknown - `department` string, nullable — The employee's department - `division` string, nullable — The employee's division - `work_email` string, nullable — The employee's work email. - `personal_email` string, nullable — The employee's personal email. - `mobile_phone_number` string, nullable — The employee's mobile phone number. - `home_phone_number` string, nullable — The employee's home phone number. - `country_code` string, nullable — The employee's country code - `home_location` HrisAddress - `name` string, nullable — Name of the location - `location` string, nullable — Location - `street_1` string, nullable — Street 1 - `street_2` string, nullable — Street 2 - `city` string, nullable — City - `state` string, nullable — State - `postal_code` string, nullable — Postal Code - `country` string, nullable — Country - `work_location` HrisAddress - `name` string, nullable — Name of the location - `location` string, nullable — Location - `street_1` string, nullable — Street 1 - `street_2` string, nullable — Street 2 - `city` string, nullable — City - `state` string, nullable — State - `postal_code` string, nullable — Postal Code - `country` string, nullable — Country - `manager` string, nullable — The employee ID of the employee's manager. - `pay_group` string, nullable — The employee's pay group - `ssn` string, nullable — The employee's social security number. - `gender` 'MALE' | 'FEMALE' | 'NON-BINARY' | 'OTHER' | 'PREFER_NOT_TO_DISCLOSE' | '-', nullable — The employee's gender. If the value is not one of the defined enum values, the original value passed through will be returned. - `ethnicity` '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' | '-', 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_status` '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' | '-', 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_use` boolean, nullable — Indicates whether the employee uses tobacco or is a smoker. - `date_of_birth` string, nullable — The employee's date of birth. - `start_date` string, nullable — The date that the employee started working. If an employee was rehired, the most recent start date will be returned. - `remote_created_at` string, nullable — When the third party's employee was created. - `employment_status` 'ACTIVE' | 'PENDING' | 'INACTIVE' | 'ACTIVE_EXTERNAL' | 'INACTIVE_EXTERNAL' | '-' | 'LEAVE' | 'DECEASED' | 'RETIRED', 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_date` string, nullable — The employee's termination date. - `termination_reason` string, nullable — The employee's termination reason. - `avatar` string, nullable — The URL of the employee's avatar image. - `payroll_run_calendar` string, nullable — The employee's payroll calendar ## Other responses - `401` — Missing or invalid bearer authentication credentials. - `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled. - `404` — The requested resource was not found. - `422` — Validation Error - `429` — Rate limit exceeded. --- [API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/versions/7da10dc93a21/schema)