v1
latestOpenAPI 3.0.02026-08-06100301483.8 KBEntity
Gets a candidate
get/Entity/Candidate
Query parameters
idinteger required
Candidate Id to return
Response
OK
Idinteger required
Forenamestring required
Surnamestring required
DateOfBirthstring date-time nullable
IsTempboolean required
IsActiveboolean required
Createdstring date-time required
LastUpdatedstring date-time required
IsRestrictedboolean required
Statusstring required
WebIdstring required
TitleIdinteger nullable
Middlenamestring required
KnownAsstring required
GenderIdinteger nullable
MaritalStatusIdinteger nullable
NationalityIdinteger nullable
SecondNationalityIdinteger nullable
ThirdNationalityIdinteger nullable
FourthNationalityIdinteger nullable
EthnicOriginIdinteger nullable
CountryOfOriginIdinteger nullable
ThirdPartyOptOutboolean required
MaximumWeeklyWorkingHoursOptOutboolean required
ContractualLegalLawfulBasis'None' | 'DigitalConsent' | 'VerbalConsent' | 'LegitimateInterest' | 'ContractualLegal' | 'LegalObligation' | 'VitalInterests' | 'PublicTask' | 'NotRequired'
ConsentLegitimateInterestLawfulBasis'None' | 'DigitalConsent' | 'VerbalConsent' | 'LegitimateInterest' | 'ContractualLegal' | 'LegalObligation' | 'VitalInterests' | 'PublicTask' | 'NotRequired'
LawfulBasisReasonIdinteger nullable
LawfulBasisOtherReasonstring required
LawfulBasisStatusIdinteger nullable
OriginOfDataIdinteger nullable
LinkedInUrlstring required
XingUrlstring required
FacebookProfileUrlstring required
TwitterProfileUrlstring required
ICaptureWebIdstring required
Photostring byte nullable
A Base64 image to display against the candidate
The image cannot exceed the max upload size configured in Infinity.
StatusIdinteger nullable
AvailabilityDatestring date-time nullable
Sourcesinteger[] required
Alertstring required
IsPermanentboolean required
IsContractboolean required
IsTemporaryboolean required
ExpectedRateCurrencyIdinteger nullable
PreferredLocationstring required
BasedInstring required
Relocateboolean required
Transportboolean required
NoticePeriodinteger required
NoticePeriodIntervalIdinteger nullable
StudentVisaboolean required
Consultantsinteger[] required
Depreciated. OwningConsultants can be used instead to return a list of consultants and their roles.
AlternateCodestring required
RightToWorkboolean required
EAAboolean required
RTWControlledByTrustIDboolean required
FestiveMailboolean required
Commentsstring required
Summarystring required
Insightsstring required
ShortlistJobCodesstring[] required
A list of valid job codes to shortlist the candidate against e.g. JO0000000112