Groups
- POSTCreate Group
- PUTEdit Group
- GETGet Group
- GETList Groups
- Configurations
- Connections
- Contacts
- Disconnections
- Enrollments
- Locations
- Plans
- Renewals
- Syncs
Members
- Employees
- Dependents
- Enrollments
- Premiums
Changes
- Snapshots
- Tracking
Legacy
- Requests
- Transactions
Get Employee
Returns the latest version of a single employee based on the ID provided.
curl --request GET \
--url https://fulfillment.noyo.com/api/v1/employees/{employee_id}{
"employment": {
"employment_dates": {
"full_time_start": "2015-01-01",
"hire_date": "2014-12-10"
},
"employment_status": "full-time",
"hours_worked": 50,
"occupation": "Senior Analyst",
"salary": {
"amount": 55000,
"type": "salary",
"unit": "annual"
},
"work_state": "CA"
},
"group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
"id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
"location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
"person": {
"contact": {
"email_address": "david@testemail.com",
"email_address_type": "home",
"home_phone": "+12065551234",
"preferred_method": "email",
"work_phone": "+12065559876"
},
"date_of_birth": "1981-06-22",
"first_name": "David",
"home_address": {
"city": "San Francisco",
"county": "San Francisco",
"state": "CA",
"street_one": "1234 Home Ave",
"zip_code": "94107"
},
"last_name": "Johnson",
"marital_status": "",
"sex": "M",
"ssn": "123456789"
},
"version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043"
}Path Parameters
The unique identifier of the employee you would like to view
Response
The date the record was originated
Employment information for the employee
Employee employment dates
ISO-8601 date string for start date as a full time employee with the group (if applicable)
ISO-8601 date string for the hire date of the employee
ISO-8601 date string for the rehire date of the employee (if applicable)
ISO-8601 date string for the retirement date of the employee (if applicable)
ISO-8601 date string for the termination date of the employee (if applicable)
Employee employment status
full-time, part-time, contract, disabled, terminated, retired An integer of hours worked per week by the employee
Employee occupation or job title
Employee salary information
Amount of salary earned by the employee in US dollars and cents, as a decimal value
x > 0Type of salary earned by the employee
hourly, salary Unit of salary earned by the employee
annual, month, semi-monthly, week, hour Unique identifier of the group in Noyo
Unique identifier of the employee in Noyo
The date the record was last updated
Personal information for the employee
ISO-8601 date string for the date of birth of the person
First name of the person
Home address of the person
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Last name of the person
Sex of the person
F, M, U, X Contact information for the person
Email address of the person
Type of email address
home, work Home phone number in E.164 format
Preferred written or spoken language of the person
Preferred method of contact for the person
mail, email, home-phone, work-phone, other True if the person can speak or communicate in English
Work phone number in E.164 format
Additional personal details of the person
American Indian status details (if applicable)
Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
True if the person is in the military
True if the person is a student
Tobacco usage details (if applicable)
Duration of tobacco use
Frequency of tobacco use
List of types of tobacco use
pipe, cigarettes, chewing-tobacco True if the person uses tobacco of any kind
Maiden name of the person (deprecated)
Mailing address of the person, if different from home address
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Marital status of the person
single, married, domestic-partner, divorced, widowed, legally-separated Middle name of the person
Social Security Number of the person
Suffix of the person
Version of the employee record
Fields that classify employees for group structure mapping
The custom identifier for this employee in your system
Unique identifier of the employee group location in Noyo
Was this page helpful?
curl --request GET \
--url https://fulfillment.noyo.com/api/v1/employees/{employee_id}{
"employment": {
"employment_dates": {
"full_time_start": "2015-01-01",
"hire_date": "2014-12-10"
},
"employment_status": "full-time",
"hours_worked": 50,
"occupation": "Senior Analyst",
"salary": {
"amount": 55000,
"type": "salary",
"unit": "annual"
},
"work_state": "CA"
},
"group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
"id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
"location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
"person": {
"contact": {
"email_address": "david@testemail.com",
"email_address_type": "home",
"home_phone": "+12065551234",
"preferred_method": "email",
"work_phone": "+12065559876"
},
"date_of_birth": "1981-06-22",
"first_name": "David",
"home_address": {
"city": "San Francisco",
"county": "San Francisco",
"state": "CA",
"street_one": "1234 Home Ave",
"zip_code": "94107"
},
"last_name": "Johnson",
"marital_status": "",
"sex": "M",
"ssn": "123456789"
},
"version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043"
}