Together requires certain core HR data to provide a seamless user experience. The Required and optional fields are outlined below.
This core data can be provided to Together via integrations. See our overview of adding user directory data.
Field | Data Type | Purpose | Required | Visible To | Comments |
employeeId | String, unique | Directory | Yes | Not displayed | |
firstName | string | Directory | Yes | Users | |
middleName | string | Directory | Yes | Users | |
lastName | string | Directory | Yes | Users | |
preferredName | string | Display | Recommended | Users | |
String, unique | Login credentials / Recipient address | Yes | Users | Ensure this is the employee email address served by the customer’s Outlook/GSuite server. e.g. "gary@example.com" | |
alternateEmails | Array of (String, unique) | Alternate email aliases (Often used post-mergers) | Recommended | Users | Ensure this is the employee email address served by the customer’s Outlook/GSuite server. e.g. ["gSmith@example.com", "gary@example2.com"] |
dateOfSeniority | string (ISO datetime) | Can be used for pairing | No | Not displayed | This is the date of last promotion |
dateInJob | string (ISO datetime) | Can be used for pairing | No | Not displayed | This is the date this employee began their current role |
departmentId | string | Pairing, Eligibility | Recommended | Not displayed | E.g. PRIVEQ |
departmentName | string | Pairing, Eligibility | Recommended | Users | E.g. “Private Equity” |
lastHireDate | string (ISO datetime) | Pairing, Reporting | Recommended | Not displayed | |
dateOfTermination | string (ISO datetime) | Reporting | Recommended | Not displayed | |
employeeStatusCode | string | Pairing, Reporting | Yes | Admins | “T” for terminated, “A” for active, "L" for on leave. If you would like reporting on employee turnover you must include terminated employee records to the maximum possible past time. |
employeeTypeCode | string | Eligibility | Recommended | Admins | E.g. “REG”, “CON” for regular, contractors |
fullTimeOrPartTimeCode | string | Eligibility | Recommended | Admins | E.g. “F”, “P” for Full-time, Part-time |
gender | string | Pairing | No | Not displayed | ‘M’ or ‘F’ |
officeId | string | Pairing | No | Not displayed | E.g. "NOREAST" |
officeAddress | string | Pairing | No | Users | E.g. "1225 Norfolk Dr" |
originalHireDate | string (ISO datetime) | Pairing | Recommended | Not displayed | Date first joining the company |
profilePictureUrl | string (URL) | Display | Recommended | Users | |
supervisorId | String, unique | Pairing, Org Chart reconstruction | Yes | Users | Must correspond to a valid employeeId. Must only have 1 supervisorId. |
title | string | Pairing | Recommended | Users | E.g. ‘Associate III’ |
addressState | string | Filtering, Directory | Recommended | Users | e.g. "ON" |
addressCountry | string | Filtering, Directory | Recommended | Users | e.g. "Canada" |
lastUpdated | String (ISO datetime) | System Sync | No | Not displayed | The last time this user's information was updated |