Skip to main content
GET
/
v0
/
budgets
List Budgets
curl --request GET \
  --url https://api.sumvin.com/v0/budgets/
{
  "_links": {},
  "budgets": [
    {
      "id": "<string>",
      "name": "<string>",
      "original_request": "<string>",
      "category_name": "<string>",
      "budget_type": "weekly",
      "limit_amount": "<string>",
      "currency": "<string>",
      "spent": "<string>",
      "remaining": "<string>",
      "daily_avg": "<string>",
      "period_start": 123,
      "period_end": 123,
      "created_at": 123,
      "updated_at": 123,
      "transactions": [
        {
          "transaction_id": "<string>",
          "amount": "<string>",
          "amount_in_budget_currency": "<string>",
          "timestamp": 123,
          "running_total": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}

Headers

x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

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

HAL-style hypermedia links for navigation and available actions.

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