Worker model

Klef’s own record of each worker from your HRIS.

Fields

Field	Type	Description
`worker.source_id`	string	The worker’s ID in the HR system.
`worker.employee_id`	string	Employee number from the HR system. Hidden from the mapping editor.
`worker.legal_name`	object	Legal name.
`worker.legal_name.given`	string	Legal first name.
`worker.legal_name.family`	string	Legal last name.
`worker.preferred_name`	object	Name the worker goes by.
`worker.preferred_name.given`	string	Preferred first name.
`worker.preferred_name.family`	string	Preferred last name.
`worker.display_name`	string	Full name for display.
`worker.business_email`	string	Primary business email address.
`worker.personal_email`	string	Primary personal email address.
`worker.status`	string	Pending, Active, Leave, Terminated, Deceased or Unspecified.
`worker.start_date`	date	Start date of the primary assignment.
`worker.end_date`	date	End date of the primary assignment.
`worker.hire_date`	date	Original hire date.
`worker.department`	object	Department of the primary assignment.
`worker.department.code`	string	Department code.
`worker.department.name`	string	Department name.
`worker.job`	object	Job of the primary assignment.
`worker.job.code`	string	Job code.
`worker.job.name`	string	Job name.
`worker.manager`	string	Source ID of the primary assignment’s manager.
`worker.location`	object	Work location of the primary assignment.
`worker.location.code`	string	Location code.
`worker.location.name`	string	Location name.
`worker.location.street`	string	Street address.
`worker.location.city`	string	City.
`worker.location.region`	string	State or region.
`worker.location.postal_code`	string	Postal code.
`worker.location.country`	string	Country.
`worker.worker_type`	string	Employee or Contractor, from the primary assignment.
`worker.preferred_language`	string	Preferred language.
`worker.mobile_phone`	string	Mobile phone number.
`worker.business_phone`	string	Business phone number.
`worker.custom_fields`	map	Fields your HR system defines, by name.
`worker.custom_fields.<name>`	string	Field value.
`worker.assignments`	array	Every job the worker holds.
`worker.assignments[].source_id`	string	The assignment’s ID in the HR system.
`worker.assignments[].is_primary`	bool	Whether this is the worker’s primary assignment.
`worker.assignments[].status`	string	Pending, Active, Leave, Terminated, Deceased or Unspecified.
`worker.assignments[].job`	object	Job of the assignment.
`worker.assignments[].job.code`	string	Job code.
`worker.assignments[].job.name`	string	Job name.
`worker.assignments[].position`	object	Position of the assignment.
`worker.assignments[].position.code`	string	Position code.
`worker.assignments[].position.name`	string	Position name.
`worker.assignments[].business_unit`	object	Business unit of the assignment.
`worker.assignments[].business_unit.code`	string	Business unit code.
`worker.assignments[].business_unit.name`	string	Business unit name.
`worker.assignments[].department`	object	Department of the assignment.
`worker.assignments[].department.code`	string	Department code.
`worker.assignments[].department.name`	string	Department name.
`worker.assignments[].cost_center`	object	Cost center of the assignment.
`worker.assignments[].cost_center.code`	string	Cost center code.
`worker.assignments[].cost_center.name`	string	Cost center name.
`worker.assignments[].location`	object	Work location.
`worker.assignments[].location.code`	string	Location code.
`worker.assignments[].location.name`	string	Location name.
`worker.assignments[].location.street`	string	Street address.
`worker.assignments[].location.city`	string	City.
`worker.assignments[].location.region`	string	State or region.
`worker.assignments[].location.postal_code`	string	Postal code.
`worker.assignments[].location.country`	string	Country.
`worker.assignments[].manager`	string	Source ID of the assignment’s manager.
`worker.assignments[].start_date`	date	Start date.
`worker.assignments[].end_date`	date	End date.
`worker.assignments[].worker_type`	string	Employee or Contractor.
`worker.assignments[].custom_fields`	map	Fields your HR system defines, by name.
`worker.assignments[].custom_fields.<name>`	string	Field value.
`worker.assignments[].org_units`	map	Organizational units the HR system places the assignment in, by type.
`worker.assignments[].org_units.<type>.code`	string	Unit code.
`worker.assignments[].org_units.<type>.name`	string	Unit name.