# Get Candidate ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /empeo/api/Recruitment/Candidate: get: summary: Get Candidate deprecated: false description: '' tags: - empeo/Recruitment parameters: - name: ApplicantNo in: query description: An identifier for applicants, formatted as a string required: false example: C000001 schema: type: string - name: PositionName in: query description: Name of the position (including Thai and English names) required: false example: Senior Backend Developer schema: type: string - name: CareerSite in: query description: Career site name required: false example: EmpeoDevTestCompany schema: type: string - name: RecruitDateStart in: query description: Start date of the Recruitment required: false example: '2024-01-01' schema: type: string - name: RecruitDateEnd in: query description: End date of the Recruitment required: false example: '2024-12-31' schema: type: string - name: PageSize in: query description: >- Number of data return per request. Can send 0 to get all candidates. (Default 50) required: false example: 10 schema: type: integer - name: PageIndex in: query description: Number of start index to be skipped (Default 0) required: false example: 25 schema: type: integer - name: Authorization in: header description: '' required: false example: '{{token}}' schema: type: string - name: Ocp-Apim-Subscription-Key in: header description: '' required: false example: '{{subscription_key}}' schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: statusCode: type: integer description: Response status code message: type: string description: Response message totals: type: integer description: Total number of data returned data: type: array items: type: object properties: applicantNo: type: string description: An identifier for applicants, formatted as a string applicantName: type: string description: Applicant name applicantNameEN: type: string description: Applicant name (In english) applicantSurName: type: string description: Applicant surname applicantSurNameEN: type: string description: Applicant surname (In english) applicantEmailAddress: type: string description: Applicant email address applicantMobileNo: type: string description: The mobile phone number of the applicant gender: type: string description: Applicant gender genderEN: type: string description: Applicant gender (In english) dateOfBirth: type: string description: The applicant's date of birth positionName: type: string description: Applicant position or job role name positionNameEN: type: string description: Applicant position or job role name (In english) CompanyName: type: string description: Applicant Company name statusName: type: string description: Applicant status statusNameEN: type: string description: Applicant status (In english) revisionNo: type: integer description: >- Number of times that applicant has registered on same position applicantAddress: type: string description: Applicant address details applicantAddressEN: type: string description: Applicant address details (In english) required: - applicantNo - applicantName - applicantNameEN - applicantSurName - applicantSurNameEN - applicantEmailAddress - applicantMobileNo - gender - genderEN - dateOfBirth - positionName - positionNameEN - CompanyName - statusName - statusNameEN - revisionNo - applicantAddress - applicantAddressEN x-apidog-orders: - applicantNo - applicantName - applicantNameEN - applicantSurName - applicantSurNameEN - applicantEmailAddress - applicantMobileNo - gender - genderEN - dateOfBirth - positionName - positionNameEN - CompanyName - statusName - statusNameEN - revisionNo - applicantAddress - applicantAddressEN description: List of recruitments x-apidog-ignore-properties: [] description: Data object required: - statusCode - message - totals - data x-apidog-orders: - statusCode - message - totals - data x-apidog-ignore-properties: [] example: statusCode: 200 message: OK totals: 3 data: - applicantNo: C230134 applicantName: TestEmsume applicantNameEN: Emsume applicantSurName: Emsume applicantSurNameEN: Emsume applicantEmailAddress: pornrattest01+666@gmail.com 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: admin@gmail.com 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: pornrattest01+666@gmail.com 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' headers: {} x-apidog-name: Success x-200:User authentication required V2.: description: '' content: application/json: schema: title: '' type: object properties: data: $ref: '#/components/schemas/Required%20authorization' status: $ref: '#/components/schemas/Response%20Error%20Msg%20' required: - data - status x-apidog-orders: - data - status x-apidog-ignore-properties: [] example: data: subCode: E9103 description: Authorization credentials required metadata: {} status: code: '4001' description: Business error with 1 errors headers: {} x-apidog-name: User authentication required V2. security: - bearerAuth: [] x-apidog: schemeGroups: - id: uyL_cJmK7q60QJZRTi5ot schemeIds: - bearerAuth required: true use: id: uyL_cJmK7q60QJZRTi5ot scopes: uyL_cJmK7q60QJZRTi5ot: bearerAuth: [] x-apidog-folder: empeo/Recruitment x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/351895/apis/api-9117666-run components: schemas: 'Response Error Msg ': type: object properties: code: type: string x-apidog-mock: '4001' description: type: string x-apidog-mock: Business error with 1 errors required: - code - description x-apidog-orders: - code - description x-apidog-ignore-properties: [] x-apidog-folder: '' Required authorization: type: object properties: subCode: type: string x-apidog-mock: E9103 description: type: string x-apidog-mock: Authorization credentials required metadata: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] required: - subCode - description - metadata x-apidog-orders: - subCode - description - metadata x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: bearerAuth: type: jwt scheme: bearer bearerFormat: JWT description: ใส่ JWT Token ในรูปแบบ Bearer {token} bearer: type: bearer scheme: bearer servers: - url: https://api.gofive.co.th description: Production security: - bearerAuth: [] x-apidog: schemeGroups: - id: uyL_cJmK7q60QJZRTi5ot schemeIds: - bearerAuth required: true use: id: uyL_cJmK7q60QJZRTi5ot scopes: uyL_cJmK7q60QJZRTi5ot: bearerAuth: [] ```