This endpoint returns a list of employees. The details are a subset of the 'unstructured' employee endpoint. This data can be filtered much more efficiently though so if you only need the basic employee details, this endpoint is preferred.

This operation supports OData queries (only $filter, $orderby, $top, $skip).

Request

GET https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employee/details

Path parameters

Parameter name Value Description Additional
businessId string Required

Request headers

Parameter name Value Description Additional
query

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

EmployeeDetailsModel