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
last_nameString

remote_created_atDateTime (ISO 8601)

remote_idString

first_nameString

emailString
Access Candidate information
Candidate fields
last_nameString

remote_dataArray

remote_updated_atDateTime (ISO 8601)

companyString

remote_created_atDateTime (ISO 8601)

remote_idString

first_nameString

titleString
Access EmailAddress information
EmailAddress fields
valueString

candidateUnknown
Access PhoneNumber information
PhoneNumber fields
valueString

candidateUnknown
Access Tag information
Tag fields
nameString

candidatesUnknown
Access Activity information
Activity fields
candidate_fkUnknown

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

remote_idString

remote_created_atDateTime (ISO 8601)

bodyString
GET/v2/{company_id}/api/offers
Merge interacts with this API endpoint to...
Access Offer information
Offer fields
remote_dataArray

start_dateDateTime (ISO 8601)

remote_created_atDateTime (ISO 8601)

remote_idString

creatorUUID

applicationUUID

closed_atDateTime (ISO 8601)

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

descriptionString

remote_updated_atDateTime (ISO 8601)

remote_created_atDateTime (ISO 8601)

codeString

remote_idString

statusEnum

nameString
Access RemoteUser information
RemoteUser fields
remote_idString

hiring_manager_for_jobsUnknown

recruiter_for_jobsUnknown
Access Url information
Url fields
valueString

jobUnknown
Access Office information
Office fields
remote_dataArray

remote_idString

jobsUnknown

nameString

locationString
Access Department information
Department fields
remote_dataArray

remote_idString

nameString

jobsUnknown
Access ScreeningQuestion information
ScreeningQuestion fields
remote_dataUnknown

remote_idString

typeEnum

titleString

jobUUID
Access ScreeningQuestionOption information
ScreeningQuestionOption fields
remote_dataUnknown

labelString

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

remote_idString

nameString
POST/v2/{company_id}/api/candidates
Merge interacts with this API endpoint to...
Access Candidate information
Candidate fields
last_nameString

remote_updated_atDateTime (ISO 8601)

remote_created_atDateTime (ISO 8601)

remote_idString

first_nameString
Access EmailAddress information
EmailAddress fields
valueString

candidateUnknown
Access PhoneNumber information
PhoneNumber fields
valueString

candidateUnknown
Access Url information
Url fields
valueString

url_typeEnum

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

remote_idString

file_nameString

file_urlString
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