Sign in
hris/employees

Retrieve Employee

Retrieve an Employee from any connected Hris software

get/hris/employees/{id}

Path parameters

idstring required

id of the employee you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Hris software.

Headers

x-connection-tokenstring required

The connection token

Response

groupsstring[] nullable

The groups the employee belongs to

locationsstring[] nullable

UUIDs of the of the Location associated with the company

employee_numberstring nullable

The employee number

company_idstring nullable

The UUID of the associated company

first_namestring nullable

The first name of the employee

last_namestring nullable

The last name of the employee

preferred_namestring nullable

The preferred name of the employee

display_full_namestring nullable

The full display name of the employee

usernamestring nullable

The username of the employee

work_emailstring nullable

The work email of the employee

personal_emailstring nullable

The personal email of the employee

mobile_phone_numberstring nullable

The mobile phone number of the employee

employmentsstring[] nullable

The employments of the employee

ssnstring nullable

The Social Security Number of the employee

genderstring nullable

The gender of the employee

ethnicitystring nullable

The ethnicity of the employee

marital_statusstring nullable

The marital status of the employee

date_of_birthstring date-time nullable

The date of birth of the employee

start_datestring date-time nullable

The start date of the employee

employment_statusstring nullable

The employment status of the employee

termination_datestring date-time nullable

The termination date of the employee

avatar_urlstring nullable

The URL of the employee's avatar

manager_idstring nullable

UUID of the manager (employee) of the employee

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the employee record

remote_idstring nullable

The remote ID of the employee in the context of the 3rd Party

remote_dataobject nullable

The remote data of the employee in the context of the 3rd Party

remote_created_atstring date-time nullable

The date when the employee was created in the 3rd party system

created_atstring date-time nullable

The created date of the employee record

modified_atstring date-time nullable

The last modified date of the employee record

remote_was_deletedboolean nullable

Indicates if the employee was deleted in the remote system

Example response

{
  "groups": [
    "Group1",
    "Group2"
  ],
  "locations": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "employee_number": "EMP001",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "first_name": "John",
  "last_name": "Doe",
  "preferred_name": "Johnny",
  "display_full_name": "John Doe",
  "username": "johndoe",
  "work_email": "john.doe@company.com",
  "personal_email": "john.doe@personal.com",
  "mobile_phone_number": "+1234567890",
  "employments": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "ssn": "123-45-6789",
  "gender": "MALE",
  "ethnicity": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
  "marital_status": "Married",
  "date_of_birth": "1990-01-01",
  "start_date": "2020-01-01",
  "employment_status": "ACTIVE",
  "termination_date": "2025-01-01",
  "avatar_url": "https://example.com/avatar.jpg",
  "manager_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "employee_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "remote_created_at": "2024-10-01T12:00:00Z",
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes