Get All Positions

The Get Positions endpoint is designed to retrieve all positions within an organization, along with their names and key details. This functionality is particularly useful for HR systems and third-party integrations that need to display or process organizational roles.

---

Endpoint Overview

• HTTP Method: GET
• Endpoint URL:
  https://api.vinter.me/api/v1/Position/GetAllPositionWithName

---

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 include the following structure:

{
  "data": [
    {
      "id": "beb1a5ca-8ff4-43a0-bd29-788dc6f58cf9",
      "title": "Software Architect Position",
      "isActive": false,
      "isCompleted": false,
      "createdAt": "2024-08-19T15:23:24.547911+03:00",
      "completedDate": null,
      "activatedDate": null
    },
    {
      "id": "38ff8726-bb96-42ed-b2d7-0ddbcda00af2",
      "title": "Software Engineer Position",
      "isActive": true,
      "isCompleted": false,
      "createdAt": "2024-02-13T18:16:37.933796+03:00",
      "completedDate": null,
      "activatedDate": "2024-02-13T18:16:37.931685+03:00"
    }
  ],
  "success": true,
  "message": null,
  "isResourceKey": true
}

---

Detailed Field Descriptions

• id:
  Unique identifier for the position.

• title:
  Name or title of the position. This is typically the position’s official designation within the organization.

• isActive:
  Boolean value indicating whether the position is currently active. true means the position is currently open or being utilized.

• isCompleted:
  Boolean value showing whether the position is completed. This typically means whether the role is no longer active or has been closed.

• createdAt:
  Timestamp indicating when the position was created.

• completedDate:
  Timestamp of when the position was marked as completed. If null, the position is not yet completed.

• activatedDate:
  Timestamp of when the position was activated. If null, the position may not be currently active.

---

Use Cases

• HR Dashboards: Retrieve and display a list of all active and inactive positions for internal review.
• Third-Party Integrations: Enable external systems to pull position data for reporting, analytics, or automation purposes.
• Process Optimization: Provide an up-to-date view of positions so that HR and recruitment teams can streamline hiring workflows.

---

Error Codes

HTTP Code	Status	Description
400	Bad Request	The request contains invalid or missing parameters.
401	Unauthorized	Authentication failed due to a missing or invalid API key.
404	Not Found	The requested resource could not be found.
500	Internal Error	An internal server error occurred.

---