Candidate

1.Get Candidate By Id

In order to access this endpoint ensure that you do a GET request with an Authorization header containing your access token.

GET <https://api.simplify.hr/v1/Candidates/{id}>

Parameters: id: string - id of the candidate Headers: Authorization : {token}

Result codes

403 Forbidden 200 OK 400 Bad request 500 Internal server error

Response

Calling this endpoint will return a full JSON object for the candidate associated with the id on the url. The main properties of a candidate are nested/grouped under a "main" property CandidateInfo.

{ **CandidateInfo **: { ... } QuestionnaireAnswers: [], CustomQuestionsAnswers: [], CandidateUtmSource: [], ApplicationNotes: [], Documents: [] }

Candidate properties

Please note that these properties are second level properties and thus returned/nested under a first level property CandidateInfo*.

Field	Type	Description
Id	int	The candidate identifier
FirstName	string (required)	Candidate's first name
LastName	string (required)	Candidate's last name
Title	string	The title of the candidate
CoverNote	string	Cover note specified when applying
Summary	string	Summary of candidate
ProfileImageUrl	string	Profile picture url retrieved from social network
CandidateSource	int (required)	Application = 0, ManualEntry = 1, CvUpload = 2, EmailApplication = 3, ExternalRecruiterEmailApplication = 4
SocialTwitter	string	Twitter account url
SocialFacebook	string	Facebook account url
SocialLinkedIn	string	LinkedIn account url
SocialGooglePlus	string	Google account url
Email	string	Email address of candidate
Phone	string	Phone number of candidate
CreatedById	int	Id of the member who created the candidate
VacancyId	int	Id of the vacancy that the candidate applied for
StageId	int	1 Applied 2 Reviewed 3 Interviewing 4 Feedback 5 Offer 6 Disqualified 7 Hired 8 PendingOnBoardingApproval 9 OnboardingRejected
CityId	int	Id of the city that the candidate lives in
CityName	string	Name of the city that the candidate lives in
CountryId	int	Country Id of the city that the candidate lives in
EthnicityId	int	1 African 2 Coloured 3 Indian/Asian 4 White
Headline	string	Candidate headline
GenderId	int	Male = 1, Female = 2, Non-binary=3
Disability	boolean (true, false)	Disabled candidate
NationalityId	int	SouthAfrican = 1, NonSouthAfrican = 2, PermanentResident = 5, NonSouthAfricanWithWorkPermit = 6
SAIdNumber	string	South African ID number
PassportNumber	string	Passport number for non South African citizens or non holders of a South African permanent residency permit
WorkPermitNumber	string	Work permit number for non South African citizens holders of a valid work permit
UpdatedById	int	Id of the member that is doing the update
Document	object	Id FileName Type Created
WhatsAppEnabled	boolean (true, false)	Indicates whether the candidate is eligible to receive WhatsApp messages sent from Simplify.hr.Please note:for this to work the WhatsApp integration needs to be activated in simplify.hr/Company/Integrations and the Phone parameter must contain the country code e.g 27825653853.

WorkHistories object:


Id	int	Id of the workhistory item
From	datetime	Start date
To	datetime	End Date
Title	string (required)	Job title of the candidate
Company	string (required)	Company that the candidate worked at
Summary	string	Duties

Education object:


Id	int	Id of the education item
From	datetime	Start date of education item
To	datetime	End date of education item
Title	string (required)	Title of education qualification
School	string	Institution

Skill object:


Id	int	Id of the skill item
Name	string (required)	Skill name

Result Format

{
    "CandidateInfo": {
        "Id": 5856,
        "FirstName": "Jane",
        "LastName": "Smith",
        "Title": null,
        "CoverNote": null,
        "Summary": "Jane is a Architect at a Global Software company.",
        "ProfileImageUrl": null,
        "CandidateSource": 1,
        "SocialTwitter": null,
        "SocialFacebook": null,
        "SocialLinkedIn": null,
        "SocialGooglePlus": null,
        "Email": "[email protected]",
        "Phone": "0871234567",
        "CreatedById": 1127,
        "UpdatedById": 1127,
        "Created": "2017-11-10T09:53:45.577",
        "Updated": "2017-11-10T09:53:45.577",
        "VacancyId": null,
        "StageId": null,
        "CityId": 30948,
        "CityName": "Cape Town",
        "CountryId": 1,
        "EthnicityId": 4,
        "ExternalRecruiterId": null,
        "Headline": null,
        "GenderId": 2,
        "Disability": null,
        "NationalityId": null,
      	"WhatsAppEnabled":false
    },
    "WorkHistories": [
        {
            "Id": 7689,
            "From": "2017-01-01T00:00:00",
            "To": "2017-10-31T00:00:00",
            "Title": "Architect",
            "Company": "Microsoft",
            "Summary": "Duties include translate business requirements into technical specifications and developing enterprise systems."
        }
    ],
    "Educations": [
        {
            "Id": 6412,
            "From": "2017-01-01T00:00:00",
            "To": "2017-12-31T00:00:00",
            "Title": "MTech: Information Technology",
            "Field": null,
            "School": "Unisa",
            "Summary": null
        }
    ],
    "Skills": [
        {
            "Id": 64107,
            "Name": "SQL"
        },
        {
            "Id": 64106,
            "Name": "ASP.NET"
        }
    ],
    "Documents": [
        {
            "Id": "f552ec84-a633-44e6-93fb-fb2481a9e0f9",
            "FileName": "JaneSmith-CV.pd",
            "Type": "CV",
            "Created": "2017-12-31T00:00:00"
        }
    ],
  "QuestionnaireAnswersResponse": [
    {
      "Id": 4120,
      "Title": "Job Application Form",
      "Questions": [
        {
          "Id": 2593222,
          "QuestionnaireId": 4120,
          "Question": "What is your highest level of education completed?",
          "Answers": [
            {
              "OptionId": 60196,
              "QuestionId": 2593222,
              "Answer": "Bachelor's Degree",
              "Score": null
            }
          ]
        },
        {
          "Id": 2593223,
          "QuestionnaireId": 4120,
          "Question": "Why are you interested in this position?",
          "Answers": [
            {
              "OptionId": null,
              "QuestionId": 2593223,
              "Answer": "I am passionate about software development and believe my skills align with the role requirements.",
              "Score": null
            }
          ]
        }
      ]
    }
  ],
  "CustomQuestionAnswersResponse": [
    {
      "Id": 31048,
      "Question": "What is your expected salary range?",
      "Answers": [
        {
          "OptionId": null,
          "QuestionId": 31048,
          "Answer": "$70,000 - $80,000 annually"
        }
      ]
    },
    {
      "Id": 31049,
      "Question": "Which of the following work arrangements do you prefer?",
      "Answers": [
        {
          "OptionId": 60706,
          "QuestionId": 31049,
          "Answer": "Remote"
        },
        {
          "OptionId": 60707,
          "QuestionId": 31049,
          "Answer": "Hybrid"
        }
      ]
    }
  ]
}