---
title: "Create an Employee Statuses Search"
method: POST
path: "/v2/companies/{companyId}/employeeStatusSearches"
tags: ["Status Searches"]
---

# Create an Employee Statuses Search

`POST /v2/companies/{companyId}/employeeStatusSearches`

## Request

- Base URL: `https://dc1demogw.paylocity.com/api`
- URL: `https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/employeeStatusSearches`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.paylocity.com/IdentityServer/connect/token` scopes: `WebLinkAPI`

> 🚧 Beta Phase
> 
> This resource is in closed beta.  Paylocity Technology Partners interested may contact the marketplace team to explore early adopter opportunities at [marketplaceapisupport@paylocity.com](mailto:marketplaceapisupport@paylocity.com) 

**Summary Description**

 Performs a employee status search for the specified company according to the search parameters passed in the request body.

## Path parameters

- `companyId` string, required

## Request body

- EmployeeStatusSearchesRequest
  - `effectiveDateFlag` 'History' | 'Future' | 'All': A flag that defines which effective dated records should be returned. If not defined the response body will contain the only the current status for each employee.
  - `employeeIds` string[]: The employee IDs to search employee statuses for

## Response `200`

Employee statuses matching the provided search criteria

- object[]
  - `employeeId` string: The employee ID
  - `statuses` object[]: An array of statuses for the specified employee
    - `adjustedSeniorityDate` string, paylocity-date: Adjusted seniority date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
    - `changeReason` string: Employee status change reason. Must match Company setup.<br /> Max length: 15
    - `effectiveDate` string, paylocity-date: Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
    - `employeeStatus` string: Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated). <br />Max length: 20
    - `hireDate` string, paylocity-date: Employee hired date. Updates to hire date are not allowed and will be ignored. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
    - `isEligibleForRehire` boolean: Indicates if employee eligible for rehire.
    - `reHireDate` string, paylocity-date: Rehire date if employee is rehired. Updates to re-hire date are not allowed and will be ignored. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
    - `recordType` 'History' | 'Current' | 'Future': The effective dated type of the pay rate record
    - `statusType` string: The Status Type associated with the Employee Status code. Each Employee Status code for a company is assigned to one of the Status Type values of A (Active), L (Leave of Absence), T (Terminated).
    - `terminationDate` string, paylocity-date: Employee termination date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.

## Other responses

- `400`: Bad request. Returned when the request contains invalid values or is missing required properties.
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paylocity/apis/weblink-api.md) - [All operations](https://skmtc.dev/paylocity/apis/weblink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/weblink-api/revisions/8152ed40b412?raw)