Retrieve Employment Details by Employee ID and Company

This operation returns a single employment detail by employee ID and companyID.

If no pagination parameters are specified, the default maximum is applied.

Permissions - UKG Pro service account must have "View" role for the "Personnel Integration" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).
Correct syntax when using date-time parameters are as follows:

  • less than (=<)
    • Example: /companies/{companyId}/employees/{employeeId}/employment-details?dateTimeCreated=<01-01-1900
  • greater than (=>)
    • Example: /companies/{companyId}/employees/{employeeId}/employment-details?dateTimeCreated=>01-01-1900
  • equal to (=)
    • Example: /companies/{companyId}/employees/{employeeId}/employment-details?dateTimeCreated=01-01-1900
  • between (={minimum date,maximum date})
    • Example: /companies/{companyId}/employees/{employeeId}/employment-details?dateTimeCreated={01-01-1900,01-01-1901}
Language
Credentials
Basic
base64
:
URL