Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Workforce Planning

Read company positions

This endpoint returns a list of company positions filtered by the specified attributes. Note that this endpoint requires body parameters, which is why it is implemented as a POST request. <br /><br /> <br /><br /> <b>Required permissions</b> <br /> To access the positions, the service user making the call must have the following permissions: <br /> Features > Workforce planning > Position management > Manage positions. <br />

post/objects/position/search

Request body

fieldsstring[] required

Array of field IDs to fetch for the positions. A list of the supported field IDs can be found in the '200 response' body detailed below. To find out the field ID of a custom field, use the <a href="https://apidocs.hibob.com/reference/get_metadata-objects-position">Get all positions fields</a> metadata endpoint. <br /> The array can contain 1 to 50 field IDs. Any invalid number of fields will get a response of 400 HTTP error.<br />

includeHumanReadableboolean

Whether to include the additional "humanReadable" entry in the response.

Example request

{
  "fields": [
    "/position/name"
  ],
  "filters": [
    {
      "fieldId": "/position/status",
      "operator": "equals",
      "values": [
        "vacant"
      ]
    }
  ]
}

Response

The positions returned in the response body.

/position/budgetstring

The backend identifier of the budget (cost) associated with this position. This field is included in the response only for positions with a defined budget. If no budget is defined, this field will not be returned. Use the budget ID to retrieve the budget amount and details through the 'Get Position Budgets' endpoint.

Example response

[
  {
    "/position/fte": {
      "humanReadable": "5",
      "value": 5
    },
    "/position/effectiveDate": {
      "humanReadable": "2023-06-23",
      "value": "2023-06-23"
    },
    "/position/endEffectiveDate": {
      "humanReadable": "2023-06-23",
      "value": "2023-06-23"
    },
    "/position/employmentType": {
      "humanReadable": "Permanent",
      "value": "Permanent"
    },
    "/position/status": {
      "humanReadable": "Vacant",
      "value": "vacant"
    },
    "/position/actualStartDate": {
      "humanReadable": "23/06/2023",
      "value": "2023-06-23"
    },
    "/position/positionType": {
      "humanReadable": "Growth",
      "value": "Growth"
    },
    "/position/filledBy": {
      "humanReadable": "Audrey Darby",
      "value": "3006749430876471221"
    },
    "/position/job": {
      "humanReadable": "Sales person  Level 1",
      "value": 128822
    },
    "/position/jobProfile": {
      "humanReadable": "Track 1 (1) Product manager (J-7760164138)",
      "value": 124599
    },
    "/position/recruitmentStatus": {
      "humanReadable": "Open",
      "value": "open"
    },
    "/position/name": {
      "humanReadable": "P-2706B",
      "value": "P-2706B"
    },
    "/position/department": {
      "humanReadable": "Accountants",
      "value": "5887485"
    },
    "/position/site": {
      "humanReadable": "Hong Kong",
      "value": 2220765
    },
    "/position/expectedStartDate": {
      "humanReadable": "17/01/2023",
      "value": "2023-01-17"
    },
    "/position/managerPositionId": {
      "humanReadable": "People and Culture \\ Director (6) Product Manager \\ P-5820313116 · London · TBH",
      "value": 15826495
    },
    "/position/managerPositionFilledBy": {
      "humanReadable": "Accountants  Sales person  Level 1  P-2706B · Hong Kong · Audrey Darby",
      "value": 257321
    },
    "/position/hasOpenRequests": {
      "humanReadable": "Yes",
      "value": true
    },
    "/position/modificationDate": {
      "humanReadable": "17/01/2023",
      "value": "2023-01-17"
    },
    "/position/id": {
      "humanReadable": "12345",
      "value": 12345
    },
    "/position/calculatedRecruitmentStatus": {
      "humanReadable": "Open",
      "value": "open"
    },
    "/position/calculatedExpectedStartDate": {
      "humanReadable": "17/01/2023",
      "value": "2023-01-17"
    },
    "/position/calculatedActualStartDate": {
      "humanReadable": "17/01/2023",
      "value": "2023-01-17"
    }
  }
]