Get Candidate - Gofive OpenAPI

Request

Query Params

ApplicantNo

string

optional

An identifier for applicants, formatted as a string

Example:

C000001

PositionName

string

optional

Name of the position (including Thai and English names)

Example:

Senior Backend Developer

CareerSite

string

optional

Career site name

Example:

EmpeoDevTestCompany

RecruitDateStart

string

optional

Start date of the Recruitment

Example:

2024-01-01

RecruitDateEnd

string

optional

End date of the Recruitment

Example:

2024-12-31

PageSize

integer

optional

Number of data return per request. Can send 0 to get all candidates. (Default 50)

Example:

PageIndex

integer

optional

Number of start index to be skipped (Default 0)

Example:

Header Params

Authorization

string

optional

Example:

Ocp-Apim-Subscription-Key

string

optional

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

statusCode

integer

required

Response status code

message

string

required

Response message

totals

integer

required

Total number of data returned

data

array [object {18}]

required

Data object

applicantNo

string

required

An identifier for applicants, formatted as a string

applicantName

string

required

Applicant name

applicantNameEN

string

required

Applicant name (In english)

applicantSurName

string

required

Applicant surname

applicantSurNameEN

string

required

Applicant surname (In english)

applicantEmailAddress

string

required

Applicant email address

applicantMobileNo

string

required

The mobile phone number of the applicant

gender

string

required

Applicant gender

genderEN

string

required

Applicant gender (In english)

dateOfBirth

string

required

The applicant's date of birth

positionName

string

required

Applicant position or job role name

positionNameEN

string

required

Applicant position or job role name (In english)

CompanyName

string

required

Applicant Company name

statusName

string

required

Applicant status

statusNameEN

string

required

Applicant status (In english)

revisionNo

integer

required

Number of times that applicant has registered on same position

applicantAddress

string

required

Applicant address details

applicantAddressEN

string

required

Applicant address details (In english)

Example

{
    "statusCode": 200,
    "message": "OK",
    "totals": 3,
    "data": [
        {
            "applicantNo": "C230134",
            "applicantName": "TestEmsume",
            "applicantNameEN": "Emsume",
            "applicantSurName": "Emsume",
            "applicantSurNameEN": "Emsume",
            "applicantEmailAddress": "[email protected]",
            "applicantMobileNo": "0989080898",
            "gender": "หญิง",
            "genderEN": "Female",
            "dateOfBirth": "2023-11-02",
            "positionName": "DateChecker",
            "positionNameEN": "DateChecker",
            "siteName": "EmpeoDevTestCompany",
            "siteNameEN": null,
            "statusName": "ปฏิเสธ",
            "statusNameEN": "Rejected",
            "revisionNo": "2",
            "applicantAddress": "Test Address กกแก้วบูรพา บางไทร พระนครศรีอยุธยา 13190",
            "applicantAddressEN": " Kok Kaeo Burapha Bang sai Ayutthaya 13190"
        },
        {
            "applicantNo": "C230133",
            "applicantName": "Admin",
            "applicantNameEN": "admin",
            "applicantSurName": "Tester",
            "applicantSurNameEN": "Tester",
            "applicantEmailAddress": "[email protected]",
            "applicantMobileNo": "0888888888",
            "gender": "หญิง",
            "genderEN": "Female",
            "dateOfBirth": "2023-07-06",
            "positionName": "DateChecker",
            "positionNameEN": "DateChecker",
            "siteName": "EmpeoDevTestCompany",
            "siteNameEN": null,
            "statusName": "รอทำแบบทดสอบ",
            "statusNameEN": "Pending Test",
            "revisionNo": "24",
            "applicantAddress": "Now you see me กกแก้วบูรพา บางไทร พระนครศรีอยุธยา 13190",
            "applicantAddressEN": " Kok Kaeo Burapha Bang sai Ayutthaya 13190"
        },
        {
            "applicantNo": "C230132",
            "applicantName": "TestEmsume",
            "applicantNameEN": "Emsume",
            "applicantSurName": "Emsume",
            "applicantSurNameEN": "Emsume",
            "applicantEmailAddress": "[email protected]",
            "applicantMobileNo": "0989080898",
            "gender": "หญิง",
            "genderEN": "Female",
            "dateOfBirth": "2023-11-02",
            "positionName": "QA",
            "positionNameEN": "QA",
            "siteName": "EmpeoDevTestCompany",
            "siteNameEN": null,
            "statusName": "ใหม่",
            "statusNameEN": "New",
            "revisionNo": "1",
            "applicantAddress": "Test Address กกแก้วบูรพา บางไทร พระนครศรีอยุธยา 13190",
            "applicantAddressEN": " Kok Kaeo Burapha Bang sai Ayutthaya 13190"
        }
    ]
}

🟠401User authentication required V2.