DEdeputy
Pay Comparison

Gets Pay Comparison Employees

Returns a list of employees matching the criteria. It is better to use the new employeeQuery field, which can match against contract ID and employee ID. NB: It is impossible to retrieve an employee if they have no contract.

post/v2/pay-comparison/get-employees

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api
  • URL
    https://your-subdomain.deputy.deputy.com/api/v2/pay-comparison/get-employees
  • Auth
    API key in header OAuth

Request body

limitinteger

Deprecated. Limit the result set returned after applying filters. Ignored when using employeeQuery.

offsetinteger

Deprecated. Offset (from the first result) the result set returned after applying filters. Ignored when using employeeQuery.

contractIdsinteger[]

Deprecated. Filter the employees based on main contract. Ignored when using employeeQuery.

Response

A successful response.

totalCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.