Parameter |
Label |
Description |
Type |
Filtering |
Max Length |
Options |
id |
Guardian system generated unique key |
int |
N/A |
firstName |
First Name |
Employee’s first name |
string |
GET |
40 |
lastName |
Last Name |
Employee’s last name |
string |
GET |
40 |
middleName |
Middle Name |
Employee’s middle name |
string |
GET |
25 |
socialSecurityNumber |
Social Security # |
Employee’s social security number |
string |
GET |
11 |
dateOfBirth |
Date of Birth |
Employee’s birthdate |
date string |
GET |
N/A |
startDate |
Date Hired |
Employee’s hire date |
date string |
N/A |
profileId |
Employee ID |
Employee’s company-issued identification |
string |
GET |
30 |
otherName |
Maiden Name |
Employee’s maiden name |
string |
GET |
40 |
jobTitle |
Title |
Employee’s title |
string |
GET |
80 |
emailAddress |
E-Mail |
Employee’s email address |
string |
GET |
80 |
locationId |
Job Location |
Employee’s assigned worksite location’s system ID |
int |
GET |
N/A |
legalEntity |
Current Business Unit |
Employee’s assigned legal entity’s system ID |
int |
GET |
N/A |
terminatedDate |
Date Terminated |
Employee’s termination date |
date string |
N/A |
languagePreference |
Preferred Language |
Employee’s preferred language (used to present onscreen help text). Send a 1 value to indicate ‘English’ and 2 to indicate ‘Spanish’ |
int |
GET |
N/A |
custom1 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
custom2 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
custom3 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
custom4 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
custom5 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
custom6 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
custom7 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
custom8 |
NA |
Optional Organization-defined custom field |
string |
GET |
255 |
notificationEmail1 |
Address 1 |
Optional organization-defined email notification recipient |
string |
255 |
notificationEmail2 |
Address 2 |
Optional organization-defined email notification recipient |
string |
255 |
addressStreet |
Line 1 |
Physical street address |
string |
80 |
addressStreet2 |
Line 2 |
Physical street address |
string |
80 |
addressApartment |
Apt # |
Apartment number |
string |
80 |
addressCity |
City |
City address |
string |
50 |
addressState |
State |
State address |
string |
20 |
addressCountry |
Country |
Country address |
string |
50 |
addressZip |
Zip |
Zip code address |
string |
10 |
workNumber |
Work Phone |
Work phone number |
string |
20 |
workExtension |
Ext |
Work phone extension number |
string |
10 |
homeNumber |
Home Phone |
Home phone number |
string |
20 |
homeExtension |
Ext |
Home phone extension number |
string |
10 |
cellNumber |
Cell Phone |
Cell phone number |
string |
20 |
cellExtension |
Ext |
Cell phone extension number |
string |
10 |