Get All Position Steps & All Applicants
This endpoint retrieves comprehensive information about a specific position, including all steps and all applicants assigned to each step.
Endpoint Overview
- HTTP Method:
GET - Endpoint URL:
https://api.vinter.me/api/v1/Position/GetStepsAndAllApplicants?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
A successful request returns a JSON object structured as follows:
{
"data": {
"positionId": "371473fc-656d-41ef-8887-3a4c5d544eca",
"title": "Senior Software Architect",
"status": "active",
"responsibleName": "Kaan KIVIRCIK",
"language": "tr-TR",
"location": "İzmir, Turkey",
"createdAt": "2025-05-07T12:05:48.508927+00:00",
"completedDate": null,
"activatedDate": "2025-05-07T12:05:48.504923+00:00",
"positionSteps": [
{
"stepName": "Yetkinlik Envanteri Testi",
"isStaticStep": false,
"staticStepId": null,
"applicants": [
{
"applicationStepId": "c29dc968-f337-4676-8e0b-407b66c2207c",
"fullName": "Batuhan SEYMAN",
"email": "[email protected]",
"stepVinterScore": 72.16,
"stepStatus": "completed"
},
{
"applicationStepId": "72e6da4d-bda5-47fa-ab9f-8617f6b29136",
"fullName": "Musa Ertek",
"email": "[email protected]",
"stepVinterScore": 86.21,
"stepStatus": "completed"
},
]
},
{
"stepName": "Backend - Teknik Değerlendirme Testi",
"isStaticStep": false,
"staticStepId": null,
"applicants": [
{
"applicationStepId": "b74732ac-f1ef-4a22-8227-d842f0c582b1",
"fullName": "Batuhan SEYMAN",
"email": "[email protected]",
"stepVinterScore": 67.79,
"stepStatus": "completed"
},
{
"applicationStepId": "2a4f2f85-cc3b-418e-a2bd-e01812b034ce",
"fullName": "Musa Ertek",
"email": "[email protected]",
"stepVinterScore": 69.45,
"stepStatus": "completed"
},
]
},
{
"stepName": "Frontend - Teknik Değerlendirme Testi",
"isStaticStep": false,
"staticStepId": null,
"applicants": [
{
"applicationStepId": "b506a16b-da8f-4e41-9547-e68b46ba99ba",
"fullName": "Batuhan SEYMAN",
"email": "[email protected]",
"stepVinterScore": 60.17,
"stepStatus": "completed"
},
{
"applicationStepId": "3b67cb88-84bc-4f12-ab81-cac67949639b",
"fullName": "Musa Ertek",
"email": "[email protected]",
"stepVinterScore": 56.48,
"stepStatus": "completed"
},
]
},
{
"stepName": "Bilişsel Yetenek Testi",
"isStaticStep": false,
"staticStepId": null,
"applicants": [
{
"applicationStepId": "9c17a9ff-6600-43e9-9875-f907ee08608c",
"fullName": "Batuhan SEYMAN",
"email": "[email protected]",
"stepVinterScore": 78.57,
"stepStatus": "completed"
},
{
"applicationStepId": "070fca9c-73f8-4e4d-b220-9bced16d4e06",
"fullName": "Musa Ertek",
"email": "[email protected]",
"stepVinterScore": 78.57,
"stepStatus": "completed"
},
]
},
{
"stepName": "Yabancı Dil Yeterlilik Testi",
"isStaticStep": false,
"staticStepId": null,
"applicants": [
{
"applicationStepId": "7893e887-07e0-4a43-be02-f5b5509e2c2d",
"fullName": "Batuhan SEYMAN",
"email": "[email protected]",
"stepVinterScore": 65.00,
"stepStatus": "completed"
},
{
"applicationStepId": "3f5f2613-ef75-42f4-867e-d9a804beadfa",
"fullName": "Musa Ertek",
"email": "[email protected]",
"stepVinterScore": null,
"stepStatus": "expected"
},
]
},
]
},
"success": true,
"message": null,
"isResourceKey": true
}
Detailed Field Descriptions
-
positionId:
The unique identifier of the position being retrieved. -
title:
The name of the position. -
status:
The current status of the position (e.g., "active", "passive", "closed"). -
responsibleName:
The name of the person responsible for the position. -
language:
The primary language associated with the position (e.g., "tr-TR", "en-US"). -
location:
The geographic location of the position. -
createdAt:
The timestamp when the position was created. -
completedDate:
The timestamp when the position was completed (if applicable). -
activatedDate:
The timestamp when the position became active. -
positionSteps:
A comprehensive list of all steps associated with the position, including:- stepName: The name of the step
- isStaticStep: Whether the step is a predefined static step
- staticStepId: The ID of the static step (if applicable)
- applicants: All applicants assigned to this step, with details including:
- applicationStepId: Unique identifier for the application step
- fullName: The full name of the applicant
- email: The email address of the applicant
- stepVinterScore: The Vinter score for this step (if available)
- stepStatus: The current status of the applicant in this step
Use Cases
-
Comprehensive Overview:
This endpoint provides a complete view of all position steps and all applicants, making it ideal for comprehensive reporting and analysis. -
Progress Monitoring:
HR and recruitment teams can track the progression of all applicants across different steps in a single request. -
Data Integration:
Third-party systems can use this comprehensive data to provide detailed analytics on position performance and applicant distribution. -
Administrative Control:
Managers can get a full overview of the recruitment pipeline, identifying bottlenecks and optimizing the hiring process.