Skip to main content
GET
/
v0
/
budgets
List Budgets
curl --request GET \
  --url https://api.example.com/v0/budgets/
{
  "_links": {
    "kyc": {
      "description": "Submit KYC information",
      "href": "/v0/user/me/kyc",
      "method": "PUT"
    },
    "self": {
      "href": "/v0/user/me",
      "method": "GET"
    },
    "wallets": {
      "href": "/v0/wallets",
      "method": "GET"
    }
  }
}

Headers

​
x-sumvin-token
string | null
​
x-juno-jwt
string | null

Query Parameters

​
budget_type
enum<string> | null

Filter by budget type

Available options:
weekly,
monthly,
yearly,
custom
​
currency
string | null

Filter by currency code

​
period_start
string | null

Filter budgets starting on or after this date. Accepts epoch ms or YYYY-MM-DD

​
period_end
string | null

Filter budgets ending on or before this date. Accepts epoch ms or YYYY-MM-DD

​
expand
string[]

Expand related resources. Options: budget_transactions

​
_search
string | null

FULLTEXT search across name, original_request, category_name

​
offset
integer
default:0

Pagination offset

Required range: x >= 0
​
limit
integer
default:20

Pagination limit

Required range: 1 <= x <= 100

Response

Budgets retrieved successfully

​
_links
Links · object
required

HAL-style hypermedia links for navigation and available actions.

​
budgets
BudgetData · object[]
required
​
total
integer
required
​
offset
integer
required
​
limit
integer
required