Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Workforce Planning

Read company positions openings

This endpoint returns a list of company positions openings filtered by the specified attributes. Note that this endpoint requires body parameters, which is why it is implemented as a POST request. <br /><br /> The required body parameters are: <br /> - Fields: Specify the fields you want to retrieve. A list of available fields can be found in the 200 response body detailed below.<br /> - Filters: Define the filtering conditions. You can filter by the fields defined in the filter section.<br /> - Pagination: This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target=”_blank”>Pagination in Bob's API</a><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/positions/position-openings/search

Request body

fieldsstring[] required

Array of field ids to fetch for the positions openings.<br /> Minimum 1 up to 50 fields. Any invalid number of fields will get a response of 400 HTTP error.<br /> You can include only the field ids listed in the '200' response below.

includeHumanReadableboolean

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

Example request

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

Response

The positions returned in the response body. You can use the fields in the response body to see the available fields for filtering the request.

Example response

{
  "positionOpeningEntries": [
    [
      {
        "/positionOpening/updateEffectiveDate": {
          "humanReadable": "23/06/2023",
          "value": "2023-06-23"
        },
        "/positionOpening/status": {
          "humanReadable": "Vacant",
          "value": "vacant"
        },
        "/positionOpening/actualStartDate": {
          "humanReadable": "23/06/2023",
          "value": "2023-06-23"
        },
        "/positionOpening/filledBy": {
          "humanReadable": "Audrey Darby",
          "value": "3006749430876471221"
        },
        "/positionOpening/recruitmentStatus": {
          "humanReadable": "Open",
          "value": "open"
        },
        "/positionOpening/positionOpeningName": {
          "humanReadable": "O-2706B",
          "value": "O-2706B"
        },
        "/positionOpening/expectedStartDate": {
          "humanReadable": "17/01/2023",
          "value": "2023-01-17"
        },
        "/positionOpening/positionId": {
          "humanReadable": "Creative  job 1  Level 1  P-1234567 · New York (Demo) · TBH",
          "value": 1234
        }
      }
    ]
  ]
}