---
title: "Gets Pay Comparison Employees"
method: POST
path: "/v2/pay-comparison/get-employees"
tags: ["Pay Comparison"]
---

# Gets Pay Comparison Employees

`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`

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.

## Request body

- PayComparisonGetEmployeesRequest
  - `limit` integer: Deprecated. Limit the result set returned after applying filters. Ignored when using `employeeQuery`.
  - `offset` integer: Deprecated. Offset (from the first result) the result set returned after applying filters. Ignored when using `employeeQuery`.
  - `contractIds` integer[]: Deprecated. Filter the employees based on main contract. Ignored when using `employeeQuery`.
  - `employeeQuery` PayComparisonEmployeeQuery
    - `limit` integer: Limit the result set returned after applying filters.
    - `offset` integer: Offset (from the first result) the result set returned after applying filters.
    - `filter` PayComparisonEmployeeQueryFilter
      - `contractIds` integer[]: Used to match employees by their contract linked by the agreement on their main location.
      - `includeEmployeeIds` integer[]: Employees with IDs matching this field will be added to the set of results, if they are not matched already.
      - `includeCompanyIds` integer[]: Employees that are associated with the Company matching any of the IDs will be added to the set of results.
      - `includeTrainingModuleIds` integer[]: Employees that have any of the matching TrainingModule IDs.
      - `includeJobPositions` string[]: Employees based on the given Job Positions. (Will be set to empty if install is not Enterprise).
      - `includeEmployeesWithNameLike` string: Employees will be added to the results if they have Name matching this value. `%` can be used as a wildcard.

## Response `200`

A successful response.

- PayComparisonGetEmployeesResponse
  - `employees` PayComparisonEmployee[]
    - `id` integer
    - `name` string
    - `profilePictureURL` string
    - `contractId` integer
    - `payrollId` string
    - `mainLocation` string
    - `contractName` string
    - `basePayRate` string
  - `totalCount` integer

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)