candidate-referrals

Get Candidate Referral

Get single candidate referral by ID

get/api/candidate-referrals/{referral_id}

Request

  • Base URL: https://api.ruzora.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.ruzora.com/api/candidate-referrals/{referral_id}
  • Auth: HTTP bearer

Path parameters

referral_idstring required

Response

Successful Response

idstring required

Record ID

referrer_typestring required
referrer_emailstring required
referred_namestring required
referred_emailstring required
referred_linkedin_urlstring nullable
referred_github_urlstring nullable
referred_skillsstring nullable
referred_locationstring nullable
referral_reasonstring nullable
relationshipstring nullable
current_rolestring nullable
current_companystring nullable
statusstring required
quality_scoreinteger required

Quality score 0-100

duplicate_of_candidate_idstring nullable
created_candidate_idstring nullable
matched_placement_idstring nullable
reward_statusstring required
reward_amountnumber nullable
reward_paid_datestring date-time nullable
conversion_datestring date-time nullable
created_atstring date-time required
estimated_rewardstring required

Display text like '$500' or '10% off invoice'

status_historyobject[]

Status change audit trail

auto_rewardobject nullable

Auto-reward result if triggered

Changes

No recorded changes to this operation across all 1 revision of this API.