---
title: "Search Employee"
method: POST
path: "/resource/Employee/QUERY"
tags: ["Employee"]
---

# Search Employee

`POST /resource/Employee/QUERY`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api/v1`
- URL: `https://your-subdomain.deputy.deputy.com/api/v1/resource/Employee/QUERY`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://once.deputy.com/my/oauth/login`
    - Token URL: `https://once.deputy.com/my/oauth/access_token`

Flexible search endpoint. Body supports `search`, `sort`, `start`, `max`, and `join` clauses. Example: `{"search": {"s1": {"field": "Id", "data": 1, "type": "eq"}}}`.

## Request body

- QueryRequest: V1 Resource search payload. All fields optional; an empty body returns the first page of results.
  - `search` object: Map of search clauses keyed by an arbitrary id (e.g. `s1`, `s2`). Each clause filters one field.
  - `sort` object: Map of field name → `asc` or `desc`.
  - `start` integer: Pagination offset (0-indexed).
  - `max` integer: Max records per page (server caps at 500).
  - `join` string[]: Related ORMs to expand inline (e.g. `["EmployeeObject"]`).

## Response `200`

Success

- Employee[]
  - `Id` integer, required
  - `Company` integer, required
  - `FirstName` string, required
  - `LastName` string, required
  - `DisplayName` string, required
  - `OtherName` string
  - `Salutation` string
  - `MainAddress` integer
  - `PostalAddress` integer
  - `Contact` integer, required
  - `EmergencyAddress` integer
  - `DateOfBirth` string, date-time
  - `Gender` integer
  - `Pronouns` integer
  - `CustomPronouns` string
  - `Photo` integer
  - `UserId` integer
  - `JobAppId` integer
  - `Active` boolean, required
  - `StartDate` string, date-time
  - `TerminationDate` string, date-time
  - `EmploymentEndDate` string, date-time
  - `EmploymentEndReason` string
  - `EmploymentEndSentiment` string
  - `EmploymentEndComment` string
  - `StressProfile` integer
  - `Position` string
  - `HigherDuty` boolean
  - `Role` integer, required
  - `AllowAppraisal` boolean, required
  - `HistoryId` integer
  - `CustomFieldData` integer
  - `OnboardingId` string
  - `ExternalLinkId` string
  - `Creator` integer
  - `Created` string, date-time
  - `Modified` string, required
  - `CompanyObject` object
  - `MainAddressObject` object
  - `PostalAddressObject` object
  - `ContactObject` object
  - `EmergencyAddressObject` object
  - `PhotoObject` object
  - `User` object
  - `JobApp` object
  - `StressProfileObject` object
  - `RoleObject` object
  - `CustomFieldDataObject` object
  - `DirtyDeputecUserAsEmployeeProfile` boolean

## Other responses

- `400`: Bad request
- `401`: Authentication required or invalid token
- `403`: Forbidden — token lacks access to this resource
- `404`: Resource not found

---

[API](https://skmtc.dev/deputy/apis/deputy-v1-resource-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/revisions/5d8e44000786?raw)
