v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Employee Service

getEmployeeNumbersV1

Retrieves a list of employee numbers from a specified location.

get/employee/v1/getEmployeeNumbers

Query parameters

isIncludeTerminatedboolean

Use true to retrieve employees whose status is Terminated.

locationCodestring required

The Code that identifies the Location in Crunchtime.

minutesSinceUpdateinteger

The number of minutes since an employee record was last updated. Use to set how far back to search.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

string[] required