Worker Statuses

Endpoint: https://api.paychex.com/companies/{companyId}/workerstatuses

Verbs supported: GET

GET: Array of statuses set at the company level which a worker could be assigned.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.


Response: Worker Status Profile  

Endpoint: https://api.paychex.com/companies/{companyId}/workerstatuses/{workerStatusId}

Verbs supported: GET

GET: Information about a single status.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
workerStatusIdstringThe ID of the worker status.

Response: Worker Status Profile  

Response

Profile: Worker Statuses

The state representation of allowed worker statuses configured for the company.
Element NameTypeDescription
workerStatusIdstringThe unique identifier associated with this status representation.
statusTypestringThe status category.
statusReasonstringThe reason of the status.
linksobjectNavigational links.

 

{
  "content": [
    {
      "workerStatusId": "00DWS906IMW2JSH8AQJ9",
      "statusType": "ACTIVE",
      "statusReason": "HIRED",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/workerstatuses/00DWS906IMW2JSH8AQJ9"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/workerstatuses"
    }
  ]
}