Unduit

Employee Detail

Retrieve full details for a single employee record by ID.

GET
/api/v1/employees/{id}

Description

Returns the complete record for a single employee, including contact details, address, employment information, and optionally their assigned assets.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Path Parameters

ParameterTypeRequiredDescription
idstringYesPass the full value from the API response in path parameters.

Query Parameters

ParameterTypeRequiredDescription
include_assetsbooleanNoSet to true or 1 to include a list of assets assigned to the employee.

Response

Top-level Fields

FieldTypeDescription
successbooleanWhether the request was successful.
employeeobjectThe employee record. See fields below.

Employee Fields

FieldTypeDescription
employee.idstringUse the full value in update routes.
employee.first_namestringEmployee's first name.
employee.last_namestringEmployee's last name.
employee.work_emailstringEmployee's work email address.
employee.emailstringLegacy alias for work_email.
employee.personal_emailstringEmployee's personal email address when available.
employee.work_phonestringWork phone number, digits only (e.g. 4155551234).
employee.work_phone_countrystringWork phone country as an ISO 3166-1 alpha-2 code (e.g. US, GB).
employee.personal_phonestringPersonal phone number, digits only.
employee.personal_phone_countrystringPersonal phone country as an ISO 3166-1 alpha-2 code.
employee.contact_infostringLegacy alias for work_phone.
employee.phone_country_codestringLegacy alias for work_phone_country.
employee.address_1stringAddress line 1.
employee.address_2stringAddress line 2. Null if not provided.
employee.citystringCity.
employee.statestringState or province.
employee.zipstringPostal or zip code.
employee.countrystringCountry as an ISO 3166-1 alpha-2 code (e.g. US, DE).
employee.location_typestringHow the employee is based (e.g. Remote Employee, Corporate Office).
employee.location_namestringDisplay name for the employee's location.
employee.departmentstringDepartment the employee belongs to.
employee.employee_idstringEmployee ID on the location record. May differ from employment_information.employee_number_id.
employee.configure_cost_center_idstringOpaque cost center ID when configured.
employee.employment_informationobjectEmployment details synced from a connected HR system. Null if unavailable. When present, only populated fields are included. See fields below.
employee.assigned_assetsarrayAssets assigned to this employee. Only included when include_assets=true. Returns [] if no assets are assigned.

employment_information Fields

FieldTypeDescription
employee.employment_information.employee_number_idstringEmployee number in the HR system. May differ from top-level employee_id.
employee.employment_information.employment_statusstringEmployment status (e.g. Active, Terminated).
employee.employment_information.employment_typestringEmployment type (e.g. Full Time, Part Time, Contractor).
employee.employment_information.employment_start_datestringStart date in YYYY-MM-DD format.
employee.employment_information.termination_datestringTermination date in YYYY-MM-DD format. Only present when employment_status is Terminated.
employee.employment_information.work_phonestringWork phone from the HR system, digits only.
employee.employment_information.managerstringEmployee's direct manager name or identifier.
employee.employment_information.personal_emailstringPersonal email as stored in the HR system.
employee.employment_information.personal_phonestringPersonal phone from the HR system, digits only.
employee.employment_information.personal_contact_countrystringPersonal phone country as an ISO 3166-1 alpha-2 code.

assigned_assets Fields

FieldTypeDescription
employee.assigned_assets[].asset_idstringCustomer asset ID.
employee.assigned_assets[].serial_numberstringDevice serial number.
employee.assigned_assets[].model_namestringProduct or model name (e.g. MacBook Pro 14).
employee.assigned_assets[].model_numberstringManufacturer model number (e.g. A2338).
employee.assigned_assets[].product_typestringDevice category (e.g. Laptop, Phone).
employee.assigned_assets[].purchase_datestringPurchase date in YYYY-MM-DD format.
employee.assigned_assets[].imeistringPrimary IMEI. Empty string if not applicable.
employee.assigned_assets[].imei2stringSecondary IMEI. Empty string if not applicable.
employee.assigned_assets[].skustringAsset SKU.
employee.assigned_assets[].asset_statusstringCurrent asset status (e.g. In Use, In Storage).

Notes

  • Pass the id from list or import responses as the {id} path parameter.
  • contact_info and phone_country_code are legacy aliases for work_phone and work_phone_country.
  • employment_information is null when no HR system is connected or no data exists for the employee. When present, only fields that contain a value are included.
  • termination_date inside employment_information is only present when employment_status is Terminated.
  • assigned_assets is only included when include_assets=true or include_assets=1 is passed. Returns [] if the employee has no assigned assets.
  • location_type values may vary in casing. Treat as case-insensitive when comparing values.
  • personal_phone and personal_email at the top level reflect what was entered in Unduit directly. The equivalent fields inside employment_information reflect what was synced from the connected HR system and may differ.

Related Endpoints

Employees List

List all employees

Add Employee

Add a new employee

Did this page help you?