Hired Candidates

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/hiredcandidates

Headers:
Authorization : {token}

Result codes

403 Forbidden
200 OK
400 Bad request
500 Internal server error

Result

One or more hired/onboarded candidate objects will be returned and will have the following fields:

Field Name	Type	Description
Id	int	The candidate identifier
FirstName	string	Candidate's first name
LastName	string	Candidate's last name
VacancyId	int	Vacancy Identifier
JobTitle	string	Either job title offer or if not present, vacancy job title
DivisionId	int	Internal Id for Division for this vacancy in the company
BusinessUnitId	int	Internal Id for Business Unit for this vacancy in the company
DepartmentId	int	Internal Id for Department for this vacancy in the company
JobGradeId	int	Unique identifier for the job grade ( null if custom job grades are not enabled in hiring preferences)
JobGradeName	string	Name of the job grade
EmploymentTypeId	int	Internal id for type of employment. 1 = Permanent 2 = Contract 3 = Part-time 4 = Internship 5 = Volunteer
EmploymentType	string	Name of the type of employment (see EmploymentTypeId)
EthnicityId	int	1 African 2 Coloured 3 Indian/Asian 4 White
GenderId	int	Male = 1, Female = 2
Disability	boolean (true, false)	Disabled candidate
NationalityId	int	SouthAfrican = 1, For other nationalities refer to list of countries returned on https://api.simplify.hr/v1/nationalities
StartDate	datetime	The date and time when the job grade was marked as deleted.Will only contain a value if the job grade was deleted, otherwise this will be null
Salary	string	Salary Rate at which the Candidate was onboarded
SaIdNumber	string	South African identification number
CurrentSalary	string	Current Salary
CurrentBenefits	string	Current Benefits

Response Format

[
    {
        "Id": 0,
        "FirstName": "FirstName A",
        "LastName": "LastName A",
        "VacancyId": 0,
        "JobTitle": "Test Engineer 4",
        "DivisionId": 22,
        "BusinessUnitId": null,
        "DepartmentId": 3,
        "JobGradeId": 1,
        "JobGradeName": "Custom Job Grade",
        "EmploymentTypeId": 1,
        "EmploymentType": "Permanent",
        "EthnicityId": 4,
        "GenderId": 1,
        "Disability": false,
        "NationalityId": 1,
        "StartDate": "2021-08-31T00:00:00",
        "Salary": "45000"
    },
    {
        "Id": 1,
        "FirstName": "FirstName B",
        "LastName": "LastName B",
        "VacancyId": 0,
        "JobTitle": "Test Engineer 4",
        "DivisionId": 22,
        "BusinessUnitId": null,
        "DepartmentId": 3,
        "JobGradeId": 1,
        "JobGradeName": "Custom Job Grade",
        "EmploymentTypeId": 1,
        "EmploymentType": "Permanent",
        "EthnicityId": 3,
        "GenderId": 2,
        "Disability": false,
        "NationalityId": 1,
        "StartDate": "2021-08-31T00:00:00",
        "Salary": "65000",
        "SaIdNumber": "2001014800086",
				"CurrentSalary":60000,
				"CurrentBenefits": "Commuter benefits"
    }
]