Retrieve Employment Details by Company ID

This operation returns all employment record details by company.

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}/employment-details?dateTimeCreated=<01-01-1900
  • greater than (=>)
    • Example: /companies/{companyId}/employment-details?dateTimeCreated=>01-01-1900
  • equal to (=)
    • Example: /companies/{companyId}/employment-details?dateTimeCreated=01-01-1900
  • between (={minimum date,maximum date})
    • Example: /companies/{companyId}/employment-details?dateTimeCreated={01-01-1900,01-01-1901}
Path Params
string
required
Query Params
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
boolean
int32
1 to 2147483647
int32
1 to 2147483647
Headers
string
required

The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for Customer API Key.

Responses

Response body
array of objects
object
string
string
string
string
string
string
string
string
string
string
string
date-time
date-time
string
string
string
string
string
string
string
date-time
date-time
date-time
date-time
string
string
string
string
string
string
string
string
string
string
string
string
string
date-time
date-time
date-time
date-time
date-time
date-time
date-time
date-time
date-time
string
string
string
string
string
string
string
string
string
string
string
string
double
double
double
string
string
string
string
string
string
string
string
double
date-time
date-time
string
string
string
string
string
404

NotFound

429

429

Language
Credentials
:
URL