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 Group Employee List
Filter employees within a group.
curl --request GET \
--url https://fulfillment.noyo.com/api/v1/groups/{group_id}/employees{
"meta": {
"offset": 0,
"page_num": 1,
"page_size": 20,
"total_records": 1
},
"response": [
{
"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"
}
},
"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"
}
]
}There may be some cases where you wish to find a specific employee in a group, but do not know their Noyo id. We provide a way to filter your employee list for a given group via query parameters. The following parameters are accepted by the API in the query string:
| Parameter | Type | Description |
|---|---|---|
date_of_birth | date | ISO-8601 date string for the date of birth of the employee to be filtered on |
first_name | string | First name of the employee to be filtered on |
last_name | string | Last name of the employee to be filtered on |
name | string | A name search for all name fields for the employee to be filtered on |
The filtering is not case-sensitive and it does not require an exact match on the value (e.g. searching for “ann” will match against “Ann” as well as “Annie”).
Path Parameters
The unique identifier of the group for which you would like to view employees
"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"
Query Parameters
The max size of each page of results
The integer offset at which to start the page. Possible values are 0 to total_records - 1
The employee first name for which you would like to filter
The employee last name for which you would like to filter
The employee's name for which you would like to filter
The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter
Status of the employees employment
Response
Metadata associated with the response data
The offset of the first response record within the matching data set
x >= 0The page number of the response records within the overall data set (1-based integer)
x >= 1The maximum number of response records on each page of results
x >= 1The total number of records in the entire matching data set
x >= 0List of employee results
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)
"2017-01-17"
ISO-8601 date string for the hire date of the employee
"2017-01-17"
ISO-8601 date string for the rehire date of the employee (if applicable)
"2018-02-01"
ISO-8601 date string for the retirement date of the employee (if applicable)
"2019-01-01"
ISO-8601 date string for the termination date of the employee (if applicable)
"2018-01-01"
Employee employment status
full-time, part-time, contract, disabled, terminated, retired An integer of hours worked per week by the employee
40
Employee occupation or job title
"Engineer"
Employee salary information
Amount of salary earned by the employee in US dollars and cents, as a decimal value
x >= 052000
Type of salary earned by the employee
hourly, salary "salary"
Unit of salary earned by the employee
annual, month, semi-monthly, week, hour "annual"
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
"1977-06-03"
First name of the person
"Catherine"
Home address of the person
City of the address
"Bend"
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 "OR"
Line one of the address
"339 Hickory Street"
Zip code of the address
"97701"
County of the address
"Deschutes"
Line two of the address
"Apartment 5"
Last name of the person
"Briggs"
Sex of the person
F, M, U, X "F"
Contact information for the person
Email address of the person
"catherine.briggs@example.com"
Type of email address
home, work "home"
Home phone number in E.164 format
"+15555551212"
Preferred written or spoken language of the person
"Engish"
Preferred method of contact for the person
mail, email, home-phone, work-phone, other "email"
True if the person can speak or communicate in English
true
Work phone number in E.164 format
"+15555551212"
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
"Ojibwe"
Disability details (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
"5 years"
Frequency of tobacco use
"Daily"
List of types of tobacco use
pipe, cigarettes, chewing-tobacco "cigarettes"
True if the person uses tobacco of any kind
true
Maiden name of the person (deprecated)
Mailing address of the person, if different from home address
City of the address
"Bend"
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 "OR"
Line one of the address
"339 Hickory Street"
Zip code of the address
"97701"
County of the address
"Deschutes"
Line two of the address
"Apartment 5"
Marital status of the person
single, married, domestic-partner, divorced, widowed, legally-separated "married"
Middle name of the person
"S"
Social Security Number of the person
"123456789"
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/groups/{group_id}/employees{
"meta": {
"offset": 0,
"page_num": 1,
"page_size": 20,
"total_records": 1
},
"response": [
{
"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"
}
},
"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"
}
]
}