PApaychex
Worker

Worker

Information about a unique worker (employee and contractor) that your application has been granted access to. Currently workers that exist within Paychex Flex payroll will be available, future enhancements will make workers from other Paychex systems available.

get/workers/{workerId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

Response

successful operation

Example response

{
  "content": {
    "workerId": "00Z5V9BTIHRQF2CF7BTH",
    "employeeId": "3052",
    "workerType": "EMPLOYEE",
    "employmentType": "FULL_TIME",
    "customEmploymentType": {
      "customEmploymentTypeId": "970008177269854",
      "customEmploymentTypeName": "Hybrid"
    },
    "exemptionType": "NON_EXEMPT",
    "birthDate": "1988-07-01T00:00:00Z",
    "sex": "MALE",
    "hireDate": "2015-06-15T00:00:00Z",
    "clockId": "4321",
    "name": {
      "familyName": "JONES",
      "middleName": "H",
      "givenName": "INDIANA",
      "preferredName": "Indi",
      "preferredLastName": "Jan",
      "pronoun": "He/him/his",
      "qualificationAffixCode": "Jr",
      "titleAffixCode": "Dr"
    },
    "seniorityDate": "2015-06-15T00:00:00Z",
    "profileImageURL": "https://cdn.url/flexworkerphotos/wrkr0ad1b60a-45cc-4bbb-b5gc-299a832ce111.jpg",
    "legalId": {
      "legalIdValue": "333221111"
    },
    "laborAssignmentId": "970001557863345",
    "locationId": "970001701620675",
    "jobId": "970001557916904",
    "job": {
      "jobTitleId": "00DWS906IMW2JSH8AQJ8",
      "title": "Archaeologist"
    },
    "organization": {
      "organizationId": "1020022951957523",
      "name": "2 Division B",
      "number": "1"
    },
    "supervisor": {
      "workerId": "00H2A1IUJ4IPERJ589YE",
      "name": {
        "familyName": "JONES",
        "middleName": "H",
        "givenName": "INDIANA",
        "preferredName": "Indi",
        "preferredLastName": "Jan",
        "pronoun": "He/him/his",
        "qualificationAffixCode": "Jr",
        "titleAffixCode": "Dr"
      }
    },
    "currentStatus": {
      "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.