User Directory Data Spec

Article author
Nathan Goldstein
  • Updated

Understand what fields Together accepts for user directory information

 

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

Required

Visible To

Comments

employeeId

String, unique

Yes

Not displayed

 

firstName

string

Yes

Users

 

middleName

string

Yes

Users

 

lastName

string

Yes

Users

 

preferredName

string

Recommended

Users

 

email

String, unique

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)

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)

No

Not displayed

This is the date of last promotion

dateInJob

string (ISO datetime)

No

Not displayed

This is the date this employee began their current role

departmentId

string

Recommended

Not displayed

E.g. PRIVEQ

departmentName

string

Recommended

Users

E.g. “Private Equity”

lastHireDate

string (ISO datetime)

Recommended

Not displayed

 

dateOfTermination

string (ISO datetime)

Recommended

Not displayed

 

employeeStatusCode

string

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

Recommended

Admins

E.g. “REG”, “CON” for regular, contractors

fullTimeOrPartTimeCode

string

Recommended

Admins

E.g. “F”, “P” for Full-time, Part-time

gender

string

No

Not displayed

‘M’ or ‘F’

officeId

string

No

Not displayed

E.g. "NOREAST"

officeAddress

string

No

Users

E.g. "1225 Norfolk Dr"

originalHireDate

string (ISO datetime)

Recommended

Not displayed

Date first joining the company

profilePictureUrl

string (URL)

Recommended

Users

https://images.pexels.com/photos/1108099/pexels-photo-1108099.jpeg?cs=srgb&dl=pexels-chevanon-photography-1108099.jpg&fm=jpg

supervisorId

String, unique

Yes

Users

Must correspond to a valid employeeId. Must only have 1 supervisorId.

title

string

Recommended

Users

E.g. ‘Associate III’

addressState

string

Recommended

Users

e.g. "ON"

addressCountry

string

Recommended

Users

e.g. "Canada"

lastUpdated

String (ISO datetime)

No

Not displayed

The last time this user's information was updated

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.