List Employees

Get

/employers/{employerId}/employees

See the guides related to this operation below.

Store values

Parameters

employerId string

The Id of the Employer for which you want to see Employees

pageNum integer

Zero-based page number, used in conjunction with pageSize (optional)

pageSize integer

The number of items per page (optional)

status string

Restrict the results to employees with the given status (optional)

deptCode string

If specified then only employees assigned to this department code will be listed (optional)

pensionSchemeId string

If specified then only employees enrolled into the given pension scheme will be listed. If empty guid(00000000-0000-0000-0000-000000000000) is passed in all employees not enrolled into any pension scheme will be listed. (optional)

sortBy string

Specifies the field by which to sort the employees. Default is EmployeeSortBy.None. (optional)

sortDescending

boolean

Specifies whether the sorting should be in descending order. Default is false. (optional)

Try it

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`Item[]`	application/json

Introduction	Items
Introduction	Paging

List Employees

Parameters

Possible Responses

Related Guides