Get Group Employee List
Filter employees within a group.
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
Successful Response - Returns all matching Employees
The response is of type object
.