---
title: "Read company positions budgets"
method: POST
path: "/positions/position-budget/search"
tags: ["Workforce Planning"]
---

# Read company positions budgets

`POST /positions/position-budget/search`

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 />

## Request body

- GetPositionsBudgetsRequest
  - `fields` string[], 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.
  - `filters` PositionBudgetFilterInstruction[], required
    - `fieldId` string, required — The field id to filter by.<br /> Supported fields: <br />“/positionBudget/id” <br />Any other path will get a response of 400 HTTP error.
    - `operator` string, required — Supported operators: “equals”, "notEqual".<br />Any other operator will get a response of 400 HTTP error.
    - `values` string[], required — List of values to compare.<br />Empty list will result in 400 HTTP error.
  - `includeHumanReadable` boolean — Whether to include the additional "humanReadable" entry in the response.
  - `pagination` object — Optional pagination parameters.
    - `limit` number — The number of results per page. Defaults to 100 if not supplied.
    - `cursor` string — A marker representing the first item on the next page to read. Should not be provided in the first call. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target=”_blank”>Pagination in Bob's API</a>.

## Response `200`

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.

- PositionBudgetResponse
  - `positionBudgetEntries` PositionBudgetEntries[]
    - object[]
      - `/positionBudget/expectedBaseSalaryCurrencyValue` object — The expected base salary related to this budget.
        - `humanReadable` string
        - `value` object
          - `value` number
          - `currency` string
      - `/positionBudget/expectedVariablePayCurrencyValue` object — The expected variable pay related to this budget.
        - `humanReadable` string
        - `value` object
          - `value` number
          - `currency` string
      - `/positionBudget/salaryPayPeriod` object — The salary pay period related to this budget. Possible values - Annual, Annual 13, Annual 14, Hourly, Daily, Weekly, Monthly, Monthly 13, Monthly 14, Quarterly
        - `humanReadable` string
        - `value` string
      - `/positionBudget/variablePayPeriod` object — The variable pay period related to this budget. Possible values - Annual, Annual 13, Annual 14, Hourly, Daily, Weekly, Monthly, Monthly 13, Monthly 14, Quarterly
        - `humanReadable` string
        - `value` string
      - `/positionBudget/currency` object — The currency defined to this budget.
        - `humanReadable` string
        - `value` string
      - `/positionBudget/totalPositionCostCurrencyValue` object — The total position cost related to this budget.
        - `humanReadable` string
        - `value` object
          - `value` number
          - `currency` string
      - `/positionBudget/convertedTotalCostCurrencyValue` object — The total position cost converted to company currency related to this budget.
        - `humanReadable` string
        - `value` object
          - `value` number
          - `currency` string
      - `/positionBudget/proRatedCostCurrencyValue` object — A calculated field that represents the total cost of a position, converted to the company’s base currency. The value is pro rated based on the portion of time within the current fiscal year when the position is active, using the position's effectiveDate and optional endEffectiveDate.
        - `humanReadable` string
        - `value` object
          - `value` number
          - `currency` string
      - `/positionBudget/updateEffectiveDate` object — The date this budget becomes effective.
        - `humanReadable` string
        - `value` string
      - `/positionBudget/id` object — The id of the budget.
        - `humanReadable` string
        - `value` number
  - `response_metadata` object
    - `next_cursor` string — Cursor for the next call, or null if there are no more results.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `429` — Rate limit exceeded
- `500` — Internal server error

---

[API](https://skmtc.net/hibob/apis/employee-data-api.md) · [All operations](https://skmtc.net/hibob/apis/employee-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hibob/employee-data-api/revisions/0781ebbdda91/schema)