# Query Employees

Endpoint: GET /companies/{companyId}/employees
Version: 1.0

## Path parameters:

  - `companyId` (string, required)

## Query parameters:

  - `id` (array, required)

  - `workplaceId` (array, required)

  - `departmentId` (array, required)

  - `state` (array, required)
    Enum: "AL", "AK", "AR", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OK", "OH", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VA", "VT", "WA", "WI", "WV", "WY"

  - `search` (string)

  - `active` (boolean)

  - `includeSearch` (boolean)

  - `includeId` (boolean)

  - `includeWorkplaceId` (boolean)

  - `includeDepartmentId` (boolean)

  - `includeState` (boolean)

  - `page` (integer)

  - `pageSize` (integer)

## Response 200 fields (application/json):

  - `hasResources` (boolean)

  - `totalResources` (integer)

  - `totalPages` (integer)

  - `pageSize` (integer)

  - `currentPage` (integer,null)

  - `previousPage` (integer,null)

  - `nextPage` (integer,null)

  - `results` (array,null)

  - `results.id` (string)

  - `results.companyId` (string)

  - `results.code` (string,null)

  - `results.firstName` (string,null)

  - `results.middleName` (string,null)

  - `results.lastName` (string,null)

  - `results.email` (string,null)

  - `results.ssnLastFour` (string,null)

  - `results.ssnValidationStatus` (string)
    Enum: "Pending", "Invalid", "Validated"

  - `results.active` (boolean)

  - `results.formW2ElectronicConsent` (boolean)

  - `results.dateOfBirth` (string,null)

  - `results.startDate` (string,null)

  - `results.terminationDate` (string,null)

  - `results.defaultPaymentMethod` (string)
    Enum: "DirectDeposit", "Manual"

  - `results.defaultNetPaySplit` (string,null)

  - `results.bankAccounts` (array,null)

  - `results.primaryWorkplaceId` (string,null)

  - `results.workplaces` (array,null)

  - `results.workplaces.name` (string,null)

  - `results.workplaces.address` (object)

  - `results.workplaces.address.street1` (string,null)

  - `results.workplaces.address.street2` (string,null)

  - `results.workplaces.address.city` (string,null)

  - `results.workplaces.address.zipcode` (string,null)

  - `results.workplaces.address.state` (string)
    Enum: "AL", "AK", "AR", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OK", "OH", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VA", "VT", "WA", "WI", "WV", "WY"

  - `results.workplaces.address.country` (string)
    Enum: "US"

  - `results.department` (object)

  - `results.residence` (object)

  - `results.wage` (object)

  - `results.wage.rate` (number)

  - `results.wage.period` (string)
    Enum: "Hourly", "Daily", "Weekly", "Biweekly", "Semimonthly", "Monthly", "Quarterly", "Annually"

  - `results.wage.flsaOvertimeExemptionStatus` (string)
    Enum: "NonExempt", "Exempt"

  - `results.wage.supplementalTaxMethod` (string)
    Enum: "Flat", "Aggregate"

  - `results.wage.fullTimeHours` (number)

  - `results.onboard` (object)

  - `results.onboard.status` (string)
    Enum: "Blocking", "NeedsAttention", "Completed"

  - `results.onboard.blockingSteps` (array,null)

  - `results.onboard.remainingSteps` (array,null)

  - `results.onboard.ssn` (array,null)

  - `results.onboard.paymentMethod` (array,null)

  - `results.onboard.employeeDetails` (array,null)

  - `results.onboard.withholdings` (array,null)

  - `results.onboard.companyDefinedAttributes` (array,null)