---
title: "Get budgets filtered and paged"
slug: "preview-get-budgets-filtered-and-paged"
updated: 2025-11-07T20:01:45Z
published: 2026-02-10T12:53:32Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get budgets filtered and paged

Post/api/v1/finance/budgets/filter

Get a paged list of existing budgets, optionally filtered to the given parameters.

		
			

**Description**

This endpoint retrieves a paged list of existing budgets, filtered to the given parameters.

**Use Case**

The user wants to use the [GET operation](/v1-api/apidocs/preview-get-a-budget) in order to obtain specific details regarding the budget, however does not know which reference/externalIdentifier to use for the specific budget. By using the filter operation and leaving 'reference' and/or 'externalIdentifier' empty the user can retrieve the list of available budgets.

**Request****fields**

The request contains the following fields:

| Field | Description |
| --- | --- |
| pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). |
| pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| columnName | The data field based on which sorting is applied. For example, if the results are sorted based on compaction code, columnName will contain the value 'compaction code'. |
| order | Based on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a). |
| reference | The unique identifier for this specific budget, created by Bloxs. |
| externalIdentifier | The unique identifier for this specific budget, not created by Bloxs. |
| budgetType | Refers to the budget type: 1 = Operating Budget, 2 = Investment Budget. |
| calendarYear | The calendar year to which the budget applies. |
| lastModified.from | The last modified date. This defines the lower border of the range. |
| lastModified.to | The last modified date. This defines the upper border of the range. |

**Response fields**

In addition to the request, the 200 response contains the fields in the table below.

| Field | Description |
| --- | --- |
| ownerReference | The reference of the relation that owns the budget. This refers to the reference created by Bloxs, not to be confused with the externalIdentifier. |

		
		
SecurityHTTPType Bearer

Please enter a valid token

Body parameters<select class='api-response-data' aria-label='Media type'><option value='0c46fd8f-becd-4f87-8504-1bfcfdf22696'>application/json</option>
</select>Expand Allobject  pagingobject (PagingInfo)  pageSizeinteger  (int32)   | null  Minimum1Maximum1000
pageNumberinteger  (int32)   | null  Minimum1Maximum9999

sortingobject (SortingInfo)  columnNamestring   | null  
orderinteger  (int32)    Valid values[
  0,
  1
]

filterobject (BudgetSearchRequestFilter)  referencestring   | null  
externalIdentifierstring   | null  
budgetTypeinteger  (int32)   | null  Valid values[
  1,
  2
]
calendarYearinteger  (int32)   | null  
lastModifiedobject (CompareFilterModelDateTime)  fromstring  (date-time)   | null  
tostring  (date-time)   | null  

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='18518f89-19c9-4905-8e6c-faea056c7273'>application/json</option>
</select>Expand Allobject  pagingobject (PagingInfo)  pageSizeinteger  (int32)   | null  Minimum1Maximum1000
pageNumberinteger  (int32)   | null  Minimum1Maximum9999

sortingobject (SortingInfo)  columnNamestring   | null  
orderinteger  (int32)    Valid values[
  0,
  1
]

budgets Array of object (BudgetSearchResultFilter)  | null  object  referencestring   | null  
externalIdentifierstring   | null  
ownerReferencestring   | null  
budgetTypeinteger  (int32)    Valid values[
  1,
  2
]
calendarYearinteger  (int32)    
lastModifiedstring  (date-time)