UKG Pro Recruiting
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with UKG Pro Recruiting API endpoints to access certain information as detailed below.
API Endpoints

GET/v2/{company_id}/api/candidates
Merge interacts with this API endpoint to...
Access RemoteUser information
RemoteUser fields
remote_created_atDateTime (ISO 8601)

remote_idString

last_nameString

emailString

first_nameString
Access Candidate information
Candidate fields
remote_dataArray

remote_created_atDateTime (ISO 8601)

companyString

remote_idString

titleString

remote_updated_atDateTime (ISO 8601)

last_nameString

first_nameString
Access EmailAddress information
EmailAddress fields
candidateUnknown

valueString
Access PhoneNumber information
PhoneNumber fields
candidateUnknown

valueString
Access Tag information
Tag fields
candidatesUnknown

nameString
Access Activity information
Activity fields
candidateUUID

candidate_fkUnknown
GET/v2/{company_id}/api/candidates/{candidate_id}/comments
Merge interacts with this API endpoint to...
Access Activity information
Activity fields
bodyString

remote_idString

remote_dataArray

remote_created_atDateTime (ISO 8601)
POST/v2/{company_id}/api/candidates
Merge interacts with this API endpoint to...
Access Candidate information
Candidate fields
remote_created_atDateTime (ISO 8601)

remote_idString

remote_updated_atDateTime (ISO 8601)

last_nameString

first_nameString
Access EmailAddress information
EmailAddress fields
candidateUnknown

valueString
Access PhoneNumber information
PhoneNumber fields
candidateUnknown

valueString
Access Url information
Url fields
candidateUnknown

url_typeEnum

valueString
POST/v2/{company_id}/api/candidates/{candidate_id}/documents
Merge interacts with this API endpoint to...
Access Attachment information
Attachment fields
file_urlString

remote_idString

attachment_typeEnum

file_nameString
POST/v2/{company_id}/api/applications
Merge interacts with this API endpoint to...
Access Application information
Application fields
remote_idString

applied_atDateTime (ISO 8601)
Access ScreeningQuestionAnswer information
ScreeningQuestionAnswer fields
applicationUnknown
GET/v2/{company_id}/api/offers
Merge interacts with this API endpoint to...
Access Offer information
Offer fields
remote_dataArray

remote_created_atDateTime (ISO 8601)

creatorUUID

applicationUUID

remote_idString

start_dateDateTime (ISO 8601)

sent_atDateTime (ISO 8601)

closed_atDateTime (ISO 8601)
GET/v2/{company_id}/api/opportunities
Merge interacts with this API endpoint to...
Access Job information
Job fields
descriptionString

remote_dataArray

remote_created_atDateTime (ISO 8601)

statusEnum

codeString

remote_idString

remote_updated_atDateTime (ISO 8601)

nameString
Access RemoteUser information
RemoteUser fields
recruiter_for_jobsUnknown

remote_idString

hiring_manager_for_jobsUnknown
Access Url information
Url fields
valueString

jobUnknown
Access Office information
Office fields
remote_dataArray

jobsUnknown

locationString

remote_idString

nameString
Access Department information
Department fields
remote_idString

remote_dataArray

jobsUnknown

nameString
Access ScreeningQuestion information
ScreeningQuestion fields
remote_dataUnknown

jobUUID

remote_idString

titleString

typeEnum
Access ScreeningQuestionOption information
ScreeningQuestionOption fields
screening_questionUnknown

remote_dataUnknown

labelString
GET/v2/{company_id}/api/applications-disposition-events
Merge interacts with this API endpoint to...
Access JobInterviewStage information
JobInterviewStage fields
remote_idString

remote_dataArray

nameString