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).
GET https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/details
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
Parameter name | Value | Description | Additional |
---|---|---|---|
query |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
EmployeeDetailsModel |
Powered by DapperDox