Search Completed New Hires

get

https://{hostname}/talent/onboarding/v2/tenants/{tenantIdentifier}/new-hires/completed

Search New Hires that have completed their onboarding process and progressed into the Completed status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantIdentifier

string

required

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

Query Params

page

integer

≤ 100

Defaults to 1

The page number to retrieve.

per_page

integer

≤ 50

Defaults to 30

The number of items to retrieve per page.

start_date_after

date-time

required

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. Must combine with the "start_date_before" value to create a timespan of 12 months or less.

start_date_before

date-time

required

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. Must combine with the "start_date_after" value to create a timespan of 12 months or less.

job

string

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

component_company

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.

work_location

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.

onboarding_owner

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.

organization_level1

string

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

organization_level2

string

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

organization_level3

string

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

organization_level4

string

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200New Hires retrieved

400Invalid request