PApaylocity
Status Searches

Create an Employee Statuses Search

🚧 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

Summary Description

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

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

Path parameters

companyIdstring required

Company Id

Request body

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.

employeeIdsstring[]

The employee IDs to search employee statuses for

Response

Employee statuses matching the provided search criteria

employeeIdstring

The employee ID

Changes

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