Worker

Worker Statuses

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.

get/workers/{workerId}/status

Request

Base URL
https://api.paychex.com
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.

Path parameters

workerIdstring required

ID associated with desired worker.

Response

successful operation

Example response

{
  "content": {
    "workerStatusId": "00DWS906IMW2JSH8AQJ9",
    "statusType": "ACTIVE",
    "statusReason": "HIRED",
    "effectiveDate": "2015-06-15T00:00:00Z"
  }
}

Changes

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