---
title: "Worker Statuses"
method: GET
path: "/workers/{workerId}/status"
tags: ["Worker"]
---

# Worker Statuses

`GET /workers/{workerId}/status`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/workers/{workerId}/status`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/workers/:workerId/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the full list of worker statuses (past, present, and future). For each status the workerStatusId is the value of the corresponding company worker status ID. If no company worker status with a matching type/reason exists then workerStatusId is omitted. If multiple statuses share an effective date the order field will indicate the order in which they were posted.

## Path parameters

- `workerId` string, required

## Response `200`

successful operation

- object
  - `metadata` MetadataResource
    - `contentItemCount` integer
    - `pagination` PaginationMetadataResource
      - `offset` integer
      - `limit` integer
      - `itemCount` integer
      - `total` integer
  - `content` Status1: The workers employment status information. This data field cannot be POSTED or PATCHED for an IN_PROGRESS worker.
    - `workerStatusId` string: The unique identifier associated with this status representation.
    - `statusType` 'ACTIVE' | 'INACTIVE' | 'TERMINATED' | 'PENDING' | 'IN_PROGRESS': The workers current status.
    - `statusReason` string: The detailed reason of the workers current status.
    - `effectiveDate` string, date-time: Date that this status has started for the worker.
    - `order` integer
    - `_links` Links
  - `links` Link1[]
    - `href` string
    - `hreflang` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string
    - `templated` boolean

## Other responses

- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)