List Applicants by Position

This endpoint retrieves information about candidates who have been invited for a particular position, along with their current status.

---

HTTP Request

• Method: GET
• URL:
  https://api.vinter.me/api/v1/Position/GetInvitedApplicantsByPosition?positionId={positionId}

---

Request Headers

Header Name	Description	Example Value
X-Api-Key	API key for organizational authentication.	api_key
Content-Type	Specifies the media type of the request.	application/json

---

Response Format

Upon a successful request, the response will be structured as follows:

{
  "data": [
    {
      "id": "754f1723-a8bc-4fa6-add1-6e91133e312c",
      "name": "Kaan",
      "surname": "KIVIRCIK",
      "email": "[email protected]",
      "status": "completed"
    },
    {
      "id": "899bfc09-1096-429c-9a4e-48eab7908316",
      "name": "Musa",
      "surname": "ERTEK",
      "email": "[email protected]",
      "status": "in_progress"
    },
    {
      "id": "754f1723-a8bc-4fa6-add1-6e91133e312c",
      "name": null,
      "surname": null,
      "email": "[email protected]",
      "status": "response_awaited"
    }
  ],
  "success": true,
  "message": null,
  "isResourceKey": true
}

---

Detailed Field Descriptions

• id:
  The unique identifier of the applicant.

• name:
  The first name of the applicant. May be null if not provided.

• surname:
  The last name of the applicant. May be null if not provided.

• email:
  The email address of the applicant. Used as the primary contact information.

• status:
  The current status of the applicant’s application process.

  • completed: The application process for this applicant is finalized.
  • in_progress: The applicant’s evaluation or hiring steps are still ongoing.
  • response_awaited: The applicant has been invited but has not yet responded.

---

Use Cases

• Candidate Tracking:
  HR teams can monitor the application status of all candidates for a specific position.

• Integration with Recruitment Tools:
  Third-party recruitment systems can use this endpoint to display real-time application status updates for individual candidates.

• Streamlined Communication:
  By knowing each applicant’s status, HR can send timely follow-ups, move candidates to the next stage, or close out completed applications.

---