Sign in
available_budgets

List all available budget amounts.

Firefly III calculates the total amount of money budgeted in so-called "available budgets". This endpoint returns all of these amounts and the periods for which they are calculated.

get/v1/available-budgets

Request

  • Base URL: https://demo.firefly-iii.org/api
  • URL: https://demo.firefly-iii.org/api/v1/available-budgets
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://demo.firefly-iii.org/oauth/authorize, token URL https://demo.firefly-iii.org/oauth/token)
    • HTTP bearer

Query parameters

limitinteger
Example:10

Number of items per page. The default pagination is per 50 items.

pageinteger
Example:1

Page number. The default pagination is per 50 items.

startstring date
Example:2025-10-01

A date formatted YYYY-MM-DD.

endstring date
Example:2025-10-31

A date formatted YYYY-MM-DD.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of available budget amounts.

Changes

No recorded changes to this endpoint across all 1 revision of this API.