Skip to main content
GET
/
v0
/
budgets
/
List Budgets
curl --request GET \
  --url https://api.sumvin.com/v0/budgets/ \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {},
  "budgets": [
    {
      "id": "<string>",
      "name": "<string>",
      "original_request": "<string>",
      "category_name": "<string>",
      "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
}

Authorizations

​
x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

​
x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

​
x-sumvin-token
string | null
​
x-sumvin-pat
string | null
​
x-juno-jwt
string | null
​
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

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