API Reference

Search In-Progress New Hires

get
https://{hostname}/talent/onboarding/v2/tenants//new-hires/in-progress

Search New Hires in one of the in-progress statuses.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.

Query Params
integer
≤ 100
Defaults to 1

The page number to retrieve.

integer
≤ 50
Defaults to 30

The number of items to retrieve per page.

date-time

The start date after which to retrieve new hires. Only new hires with a start date set and occurring after this time will be returned.

date-time

The start date before which to retrieve new hires. Only new hires with a start date set and occurring before this time will be returned.

string

The UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned.

string

The UKG Pro component company code or Onboarding component company identifier to filter by. Only New Hires with this component company will be returned.

string

The UKG Pro work location code or Onboarding work location identifier to filter by. Only New Hires with this work location will be returned.

string

The UKG Pro Person identifier or Onboarding employee identifier to filter by. Only New Hires with this person as the Onboarding Owner will be returned.

string

The UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned.

string

The UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned.

string

The UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned.

string

The UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned.

string
enum

The status of the new hire. Only new hires with the specified status will be returned.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 7 days ago

Did this page help you?