cURL
curl --request GET \ --url https://api.example.com/api/Candidates/{candidateId}
{ "id": 123, "fullName": "<string>", "candidateDisplayName": "<string>", "preferredName": "<string>", "firstName": "<string>", "lastName": "<string>", "email1": "<string>", "email2": "<string>", "payrollEmail": "<string>", "payrollCountry": "<string>", "payrollState": "<string>", "mobile": "<string>", "home": "<string>", "work": "<string>", "mobile_Standardised": "<string>", "home_Standardised": "<string>", "work_Standardised": "<string>", "jobTitle": "<string>", "employer": "<string>", "genderID": 123, "hasResumeViewerDoc": true, "resumeViewerDate": "2023-11-07T05:31:56Z", "isOwnerOfHasResumeViewerDoc": true, "resumeUpdateDate": "2023-11-07T05:31:56Z", "lastUpdateDate": "2023-11-07T05:31:56Z", "address1": "<string>", "address2": "<string>", "suburb": "<string>", "state": "<string>", "postcode": "<string>", "countryName": "<string>", "countryCode": "<string>", "linkedInUrl": "<string>", "facebookUrl": "<string>", "photoName": "<string>", "photoUrl": "<string>", "dateOfBirth": "2023-11-07T05:31:56Z", "preferredRate": 123, "preferredRateUnitsId": 123, "preferredRateUnits": "<string>", "preferredSalary": 123, "preferredSalaryUnitsId": 123, "preferredSalaryUnits": "<string>", "jobSeekingStatusID": 123, "jobSeekingStatusName": "<string>", "preferredJobTypeID": 123, "preferredJobTypeName": "<string>", "summary": "<string>", "profileStatusID": 123, "candidateClientID": 123, "candidateClientName": "<string>", "candidatePlacementTypeID": 123, "candidatePlacementClientID": 123, "candidatePlacementClientName": "<string>", "hasResume": true, "isRedFlagged": true, "redFlaggedDate": "2023-11-07T05:31:56Z", "redFlaggedByUserName": "<string>", "redFlaggedComments": "<string>", "tags": true, "divisions": "<string>", "availabilityDate": "2023-11-07T05:31:56Z", "optOut": true, "weeksNotice": 123, "nationality": "<string>", "nationalityID": 123, "website": "<string>", "statisticsCounts": [ { "type": "<string>", "value": 123 } ], "statisticsDates": [ { "type": "<string>", "value": "2023-11-07T05:31:56Z" } ], "deleted": true, "customField1": "<string>", "customField2": "<string>", "customField3": "<string>", "customField4": "<string>", "customField5": "<string>", "customField6": "<string>", "customField7": "<string>", "customField8": "<string>", "customField9": "<string>", "customField10": "<string>", "customField11": "<string>", "customField12": "<string>", "customField13": "<string>", "customField14": "<string>", "customField15": "<string>", "customField16": "<string>", "customField17": "<string>", "customField18": "<string>", "customField19": "<string>", "customField20": "<string>", "customField21": "<string>", "customField22": "<string>", "customField23": "<string>", "customField24": "<string>", "customField25": "<string>", "customField26": "<string>", "customField27": "<string>", "customField28": "<string>", "customField29": "<string>", "customField30": "<string>", "customField31": "2023-11-07T05:31:56Z", "customField32": "2023-11-07T05:31:56Z", "customField33": "2023-11-07T05:31:56Z", "customField34": "2023-11-07T05:31:56Z", "customField35": "2023-11-07T05:31:56Z", "customField36": "2023-11-07T05:31:56Z", "customField37": "2023-11-07T05:31:56Z", "customField38": "2023-11-07T05:31:56Z", "customField39": "2023-11-07T05:31:56Z", "customField40": "2023-11-07T05:31:56Z", "customField41": "2023-11-07T05:31:56Z", "customField42": "2023-11-07T05:31:56Z", "customField43": "2023-11-07T05:31:56Z", "customField44": "2023-11-07T05:31:56Z", "customField45": "2023-11-07T05:31:56Z", "customField46": 123, "customField47": 123, "customField48": 123, "customField49": 123, "customField50": 123, "customField51": 123, "customField52": 123, "customField53": 123, "customField54": 123, "customField55": 123, "customField56": 123, "customField57": 123, "customField58": 123, "customField59": 123, "customField60": 123, "linkedInProfilePictureUrl": "<string>", "originalSource": "<string>", "lastApplicationDate": "2023-11-07T05:31:56Z", "employmentHistories": [ { "jobTitle": "<string>", "employer": "<string>", "startDate": "2023-11-07T05:31:56Z", "endDate": "2023-11-07T05:31:56Z" } ] }
Returns a single Candidate based on the id passed.
OK
Show child attributes
Was this page helpful?