--- title: List budget configurations with time filtering slug: reference/list-budget-configurations-with-time-filtering docTags: createdAt: 2025-07-03T16:20:35.017Z --- { "id": "uX6vKgdCJR0DpnwnNglZK", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/business-unit/budget", "servers": [ { "url": "https://app.amberflo.io/business-unit/budget" } ], "name": "List budget configurations with time filtering", "description": "

Retrieves paginated list of budget configurations for business units in your organization.\nBudgets define spending limits and cost allocation targets for cloud resources assigned to business units.

\n

Required parameters:

\n\n

Optional parameters:

\n\n

Returns paginated budget data including cost allocation rules, spending limits, and time period configurations.\nUse time filters to find budgets that were active during specific periods for historical analysis.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "limit", "type": "integer", "description": "

Maximum number of budget records to return per page. Must be between 1 and 1000, defaults to 50.

" }, { "kind": "optional", "name": "page", "type": "integer", "description": "

Zero-based page number for pagination. Used with limit parameter to navigate through large result sets.

" }, { "kind": "optional", "name": "timeInSeconds", "type": "integer", "description": "

Filter for items active at this point in time, in Unix time (seconds).

" }, { "kind": "optional", "name": "startTimeInSeconds", "type": "integer", "description": "

Filter for items active after (inclusive) this point in time, in Unix time (seconds).

" }, { "kind": "optional", "name": "endTimeInSeconds", "type": "integer", "description": "

Filter for items active before (exclusive) this point in time, in Unix time (seconds).

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Paginated response for budget listing operations. Contains budget configurations with metadata for navigation through large result sets.", "customType": "business_unit.budget.BudgetPage.out", "schema": [ { "name": "metadata", "kind": "optional", "type": "object", "description": "Pagination metadata including page size, current page number, total records count, and applied filter parameters.", "modelRef": "#/components/schemas/business_unit.budget.BudgetPageMetadata.out", "customType": "business_unit.budget.BudgetPageMetadata.out", "schema": [ { "name": "limit", "kind": "optional", "type": "integer", "description": "Maximum number of budget records per page. Controls pagination size for result set management and API performance.", "example": 0 }, { "name": "page", "kind": "optional", "type": "integer", "description": "Current page number in pagination sequence. Zero-based indexing used for navigating through multiple result pages.", "example": 0 }, { "name": "timeInSeconds", "kind": "optional", "type": "integer", "description": "Filter timestamp for budget activity in Unix seconds. Returns budgets that were active at this specific point in time.", "example": 0 }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "Filter start time for budget activity in Unix seconds. Inclusive lower bound for time-based budget filtering.", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "Filter end time for budget activity in Unix seconds. Exclusive upper bound for time-based budget filtering.", "example": 0 }, { "name": "totalRowCount", "kind": "optional", "type": "integer", "description": "Total number of budget records across all pages. Used for calculating pagination controls and progress indicators.", "example": 0 }, { "name": "filteredRowCount", "kind": "optional", "type": "integer", "description": "Number of budget records after applying filters. May be less than totalRowCount when time filters are active.", "example": 0 }, { "name": "totalFilteredPages", "kind": "optional", "type": "integer", "description": "Total pages available after filtering. Calculated from filteredRowCount divided by page limit for navigation.", "example": 0 } ] }, { "name": "items", "kind": "optional", "type": "array", "description": "Array of budget configurations for the current page. Each item contains complete budget definition including limits and filters.", "modelRef": "#/components/schemas/business_unit.budget.Budget.out", "customType": "business_unit.budget.Budget.out[]", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "Unique identifier for budget configuration. Used for API references and must be unique within the account's budget registry.", "example": "" }, { "name": "label", "kind": "required", "type": "string", "description": "Human-readable display name for budget configuration. Used in dashboards and reports for easy identification by users.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining budget purpose, scope, and allocation strategy. Supports markdown formatting for rich documentation.", "example": "" }, { "name": "limit", "kind": "required", "type": "number", "description": "Maximum spending threshold for this budget in account currency. When exceeded, triggers notifications and optional enforcement actions.", "example": "" }, { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Budget validity start time in Unix timestamp seconds. Inclusive lower bound when budget rules become active.", "example": 0 }, { "name": "endTimeInSeconds", "kind": "required", "type": "integer", "description": "Budget validity end time in Unix timestamp seconds. Exclusive upper bound when budget rules stop applying.", "example": 0 }, { "name": "filter", "kind": "optional", "type": "map", "description": "Cost filtering criteria for budget scope. Key-value pairs define which resources and costs count towards budget limit.", "example": "", "customType": "map", "schema": [] }, { "name": "usageItem", "kind": "required", "type": "string", "description": "Cost metric type tracked by this budget. Examples include EffectiveCost, BilledCost, or custom usage items.", "example": "" }, { "name": "createTimeInMillis", "kind": "optional", "type": "integer", "description": "Budget creation timestamp in Unix milliseconds. System-generated when budget configuration is first created.", "example": 0 }, { "name": "updateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last modification timestamp in Unix milliseconds. Updated automatically whenever budget configuration changes.", "example": 0 } ] } ], "modelRef": "#/components/schemas/business_unit.budget.BudgetPage.out", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "lygclz6EU9fQAHfg-lz2G", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/business-unit/budget \\\n --header 'accept: application/json'" }, { "id": "TjOvHQY_O8xFdBHxhMZt3", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/business-unit/budget\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "EkIDs5h-9g9rtKzXw_IPm", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/business-unit/budget\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "LPJGFrEB1Dh4bDOhBkbtB", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/business-unit/budget\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "lygclz6EU9fQAHfg-lz2G" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful request\n{\n \"metadata\": {\n \"limit\": \"\",\n \"page\": \"\",\n \"timeInSeconds\": \"\",\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"totalRowCount\": \"\",\n \"filteredRowCount\": \"\",\n \"totalFilteredPages\": \"\"\n },\n \"items\": [\n {\n \"code\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"limit\": 0,\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"filter\": \"\",\n \"usageItem\": \"\",\n \"createTimeInMillis\": \"\",\n \"updateTimeInMillis\": \"\"\n }\n ]\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "", "id": "cEl3_SLZ9_UWb-udzL0cW" } ] }