Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Workforce Planning

Read company positions budgets

This endpoint returns a list of company positions budgets 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-budget/search

Request body

fieldsstring[] required

Array of field ids to fetch for the positions budgets.<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": [
    "/positionBudget/id"
  ],
  "filters": [
    {
      "fieldId": "/positionBudget/id",
      "operator": "equals",
      "values": [
        "12345"
      ]
    }
  ]
}

Response

The budgets 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

{
  "positionBudgetEntries": [
    [
      {
        "/positionBudget/expectedBaseSalaryCurrencyValue": {
          "humanReadable": "12345$",
          "value": {
            "value": 12345,
            "currency": "USD"
          }
        },
        "/positionBudget/expectedVariablePayCurrencyValue": {
          "humanReadable": "12345$",
          "value": {
            "value": 12345,
            "currency": "USD"
          }
        },
        "/positionBudget/salaryPayPeriod": {
          "humanReadable": "Weekly",
          "value": "Weekly"
        },
        "/positionBudget/variablePayPeriod": {
          "humanReadable": "Weekly",
          "value": "Weekly"
        },
        "/positionBudget/currency": {
          "humanReadable": "$",
          "value": "USD"
        },
        "/positionBudget/totalPositionCostCurrencyValue": {
          "humanReadable": "12345$",
          "value": {
            "value": 12345,
            "currency": "USD"
          }
        },
        "/positionBudget/convertedTotalCostCurrencyValue": {
          "humanReadable": "12345$",
          "value": {
            "value": 12345,
            "currency": "USD"
          }
        },
        "/positionBudget/proRatedCostCurrencyValue": {
          "humanReadable": "12345$",
          "value": {
            "value": 12345,
            "currency": "USD"
          }
        },
        "/positionBudget/updateEffectiveDate": {
          "humanReadable": "23/06/2023",
          "value": "23/06/2023"
        },
        "/positionBudget/id": {
          "humanReadable": "12345",
          "value": 12345
        }
      }
    ]
  ]
}