PApaychex
Company

Company Workers

Array of workers (employee and contractor) for all of the companies who are associated with a specific company that your application has been granted access to. The combination of query parameters to be used with this endpoint are as follows: 1. givenname, familyname, legallastfour 2. from, to (start date, end date) 3. employeeid 4. locationid 5. offset, limit (paging). Note: Paging and filtering attributes cannot be applied together.

get/companies/{companyId}/workers

Request

Path parameters

companyIdstring required

The id assigned to the company that workers are being requested for.

Query parameters

givennamestring

The given or first name of the workers to search for.

familynamestring

The family or last name of the workers to search for.

legallastfourstring

The last 4 digits of the workers federal level taxpayer id number of the worker to search for.

employeeidstring

The assigned workers employee ID.

fromstring

The beginning of the search date range using for when the worker was created.

tostring

The ending of the search date range using for then the worker was created.

locationidstring

The location id of the worker

Response

successful operation

Example response

{
  "content": {
    "workerId": "00Z5V9BTIHRQF2CF7BTH",
    "employeeId": "3052",
    "employmentType": "NON_EXEMPT",
    "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": "2020-05-20T00:00:00Z",
    "profileImageURL": "https://cdn.url/flexworkerphotos/wrkr0ad1b60a-45cc-4bbb-b5gc-299a832ce111.jpg",
    "legalId": {
      "legalIdValue": "995886885"
    },
    "laborAssignmentId": "970001557863345",
    "jobId": "970001557916904",
    "locationId": "970001701620675",
    "job": {
      "jobTitleId": "00DWS906IMW2JSH8AQJ8",
      "title": "Archaeologist",
      "startDate": "2010-01-01T00:00:00Z",
      "endDate": "2016-12-31T00:00:00Z"
    },
    "organization": {
      "organizationId": "970000055981384",
      "name": "2 Division B",
      "number": "2",
      "level": "Level 2"
    },
    "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",
      "statusReason": "HIRED"
    },
    "communications": [
      {
        "communicationId": "00Z5V9BTINBT97UMERCA",
        "type": "STREET_ADDRESS",
        "usageType": "BUSINESS",
        "streetLineOne": "Mike St",
        "streetLineTwo": "Sulley Ln",
        "city": "ANAHEIM",
        "postalCode": "92802",
        "countrySubdivisionCode": "CA",
        "countryCode": "US"
      }
    ]
  }
}

Changes

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