Skip to main content

Get Position Detail

This endpoint retrieves detailed information about a specific position, including steps and associated applicants.

Endpoint Overview​

  • HTTP Method: GET
  • Endpoint URL:
    https://api.vinter.me/api/v1/Position/GetStepsAndApplicants?positionId=2ec6acd7-b976-4a58-aff4-e32c4121d73f

Request Headers​

Header NameDescriptionExample Value
X-Api-KeyAPI key for organizational authentication.api_key
Content-TypeSpecifies the media type of the request.application/json

Response Format​

A successful request returns a JSON object structured as follows:

{
  "data": {
    "positionId": "2ec6acd7-b976-4a58-aff4-e32c4121d73f",
    "title": "Software Architect Position",
    "isActive": true,
    "isCompleted": false,
    "responsibleName": "Murat SAHIN",
    "language": "en-US",
    "location": "London, United Kingdom",
    "createdAt": "2025-02-11T17:28:00.164484+03:00",
    "completedDate": null,
    "activatedDate": "2025-02-12T14:38:39.452059+03:00",
    "positionSteps": [
      {
        "stepName": "Technical Assesment Test",
        "isStaticStep": false,
        "staticStepId": null,
        "applicants": [
          {
            "fullName": "Kaan KIVIRCIK",
            "email": "[email protected]",
            "isGeneralApplicationFormFilled": null,
            "stepVinterScore": null,
            "isStepCompleted": false
          }
        ]
      },
      {
        "stepName": "Kısa Liste",
        "isStaticStep": true,
        "staticStepId": "3",
        "applicants": []
      }
    ]
  },
  "success": true,
  "message": null,
  "isResourceKey": true
}

Detailed Field Descriptions​

  • positionId:
    The unique identifier of the position being retrieved.

  • title:
    The name of the position.

  • isActive:
    Indicates whether the position is currently active.

  • isCompleted:
    Specifies whether the position has been completed.

  • responsibleName:
    The name of the person responsible for the position.

  • language:
    The primary language associated with the position.

  • 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 list of steps associated with the position, including their names, whether they are static or dynamic, and the applicants assigned to each step.

Use Cases​

  • Progress Tracking:
    This endpoint allows HR and recruitment teams to monitor the status and progression of a position through various stages.

  • Data Integration:
    Third-party systems can use this data to provide detailed reporting and analytics on position statuses and applicant pools.

  • Improved Decision Making:
    By having a clear view of active and completed steps, managers can identify bottlenecks and streamline the hiring process.