UKG Pro (Recruiting) - Search records action

The Search records action retrieves a list of records from UKG Pro (Recruiting) that match your search criteria.

Input

Input fieldDescription
ObjectSpecify the type of object to search. Additional fields load dynamically based on the object you select.

Workato dynamically populates additional fields depending on the object you select. For example, the Candidate object has the following input fields:

Input fieldsDescription
PageSpecify a page number to return paginated records.
Per pageSpecify the number of records to return per page.
Candidate typeSelect the type of candidate to return. Defaults to all.
Updated afterSpecify a date to filter records by. The action only returns records updated after this date.
RoleSelect the role to filter the returned candidates.
Updated beforeSpecify a date to filter records by. The action only returns records updated before this date.

Output

The output fields are determined by the object selected in the input. Map the relevant datapill from the data tree to subsequent steps. For example, the Candidate object has the following output schema:

Output fieldDescription
IDThe unique ID of a candidate in GUID format.
CreatorThe creator of a candidate record.
Created atThe date and time a candidate was created.
Util person IDThe UKG Pro person ID.
EEIDThe employee identifier.
Preferred_localeThe preferred language of the candidate.
Integration user IDThe user ID used in 3rd party integrations, such as background check integrations.
Is internalindicator of whether or not a candidate is an internal employee.
Is activeindicator of whether or not a candidate is an active employee.
Updated atThe date and time a candidate was last updated.

Last updated: