Get a single person detail record for a single company

Get a single person detail record for a single company.
If no pagination parameters specified, the default/max is applied.
Permissions - UKG Pro service account must have "View" role for the "Employee Person Details" 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}/person-details?dateTimeCreated=<01-01-1900
  • greater than (=>)
    • Example: /companies/{companyId}/employees/{employeeId}/person-details?dateTimeCreated=>01-01-1900
  • equal to (=)
    • Example: /companies/{companyId}/employees/{employeeId}/person-details?dateTimeCreated=01-01-1900
  • between (={minimum date,maximum date})
    • Example: /companies/{companyId}/employees/{employeeId}/person-details?dateTimeCreated={01-01-1900,01-01-1901}
Path Params
string
required
string
required
Query Params
string
string
string
string
string
string
string
string
string

Used to find date of COBRA event less than, greater than, equal to, or between passed date(s)

string

Used to find person record created less than, greater than, equal to, or between passed date(s)

string

Used to find person record changed less than, greater than, equal to, or between passed date(s)

string
string
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

404

NotFound

Language
Credentials
:
URL
Choose an example:
application/json
text/json
application/problem+json