Get all person details

Get all person details.
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: /person-details?dateTimeCreated=<01-01-1900
  • greater than (=>)
    • Example: /person-details?dateTimeCreated=>01-01-1900
  • equal to (=)
    • Example: /person-details?dateTimeCreated=01-01-1900
  • between (={minimum date,maximum date})
    • Example: /person-details?dateTimeCreated={01-01-1900,01-01-1901}
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

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

NotFound

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