Sign in
hris/dependents

Retrieve Dependent

Retrieve a Dependent from any connected Hris software

get/hris/dependents/{id}

Path parameters

idstring required

id of the dependent 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

first_namestring nullable

The first name of the dependent

last_namestring nullable

The last name of the dependent

middle_namestring nullable

The middle name of the dependent

relationshipstring nullable

The relationship of the dependent to the employee

date_of_birthstring date-time nullable

The date of birth of the dependent

genderstring nullable

The gender of the dependent

phone_numberstring nullable

The phone number of the dependent

home_locationstring nullable

The UUID of the home location

is_studentboolean nullable

Indicates if the dependent is a student

ssnstring nullable

The Social Security Number of the dependent

employee_idstring nullable

The UUID of the associated employee

field_mappingsobject nullable

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

idstring nullable

The UUID of the dependent record

remote_idstring nullable

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

remote_dataobject nullable

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

remote_created_atstring date-time nullable

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

created_atstring date-time nullable

The created date of the dependent record

modified_atstring date-time nullable

The last modified date of the dependent record

remote_was_deletedboolean nullable

Indicates if the dependent was deleted in the remote system

Example response

{
  "first_name": "John",
  "last_name": "Doe",
  "middle_name": "Michael",
  "relationship": "CHILD",
  "date_of_birth": "2020-01-01",
  "gender": "MALE",
  "phone_number": "+1234567890",
  "home_location": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "is_student": true,
  "ssn": "123-45-6789",
  "employee_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "dependent_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