Returns employees

post

https://api.hcssapps.com/heavyjob/api/v1/employees/advancedRequest

This call returns a list of employees for the specified business unit, employees, accounting template, active status, foreman status, and deleted status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Set of filters for the request.

A POCO that represents a request for employee.

businessUnitId

uuid

required

The business unit id.

employeeCodes

array of strings | null

List of employee codes.

employeeCodes

employeeIds

array of uuids | null

List of employee ids.

employeeIds

accountingTemplateName

string | null

The accounting template name.

isActive

boolean | null

The active flag.

isForeman

boolean | null

The active foreman flag.

includeHistoricalForeman

boolean | null

The historical foreman flag.

isDeleted

boolean | null

The soft-deleted flag.

cursor

string | null

Optional.
When there are additional results, the metadata nextCursor field
should be passed to retrieve the next page of results.

limit

int32 | null

The maximum number of results that should be returned.

includeJobAccountingValues

boolean

When true, includes job-level accounting override values for each employee.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK