employees
Retrieve a list of employees by filtering on a limited set of URI parameters.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| employeeId |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| firstName |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| middleName |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| lastName |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| phoneNumber |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| emailAddress |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| hireDate |
Used for filtering. Only includes employees which have a hire date less than or equal to the date provided. |
string |
None. |
| terminationDate |
Used for filtering. Only includes employees which have a termination date less than or equal to the date provided. |
string |
None. |
| company |
Used for filtering. Only includes employees that are a partial or complete match with the given Company name. |
string |
None. |
| isTerminated |
Used for filtering. |
boolean |
None. |
| hasUserAccount |
Used for filtering list of employees to those that are able or unable to login. |
boolean |
None. |
| username |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| resetPasswordPermissionFrom |
Used for filtering. Only includes employees that are a partial or complete match. |
integer |
None. |
| emergencyContactPhoneNumber |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| emergencyContactName |
Used for filtering. Only includes employees that are a partial or complete match. |
string |
None. |
| sort |
Sort by the specified URI parameter. Sort can be applied to title and IsSignedOff fields. i.e. url?sort=title or url?sort=IsSignedOff. The default sort direction is ascending. |
string |
None. |
| sortDirection |
Sorts in ascending or descending order. "Asc" for ascending order, or "Desc" for descending order. |
string |
None. |
Body Parameters
None.
Response Information
Standard Responses
A list of employees that match the filtering criteria
| Name | Description | Type | Additional information |
|---|---|---|---|
| pagingInfo | PagingInfoDto |
None. |
|
| values | Collection of EmployeeDto |
None. |
|
| links | Collection of LinkDto |
None. |
Error Responses
| HTTP Status Code | Error Message | Type | Additional Information |
|---|