List all budgets visible to the user

GET

/budgets

const url = 'http://localhost:8000/api/v1/budgets?limit=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:8000/api/v1/budgets?limit=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

active

boolean

If true, only return active budgets

limit

integer

default: 20

Number of items to return per page

synced_since

string format: date-time

Get recent changes after this date

no_client_id

boolean

Get results with no client id

Responses

200

Successful operation

application/json

object

data

Array<object>

object

integer

owner_id

integer

owner_type

string

name

string

slug

string

description

string

nullable

amount

number format: float

currency

string

period_type

string

Allowed values: weekly monthly yearly custom

start_date

string format: date

end_date

string format: date

nullable

rollover_enabled

boolean

threshold_percent

integer

forecast_alerts_enabled

boolean

is_active

boolean

targets

Array<object>

object

type

string

Allowed values: category group wallet

integer

client_generated_id

string

nullable

name

string

progress

object

period_start

string format: date

period_end

string format: date

limit

number format: float

gross_spent

number format: float

refunds

number format: float

net_spent

number format: float

rollover_in

number format: float

effective_limit

number format: float

remaining

number format: float

percent_used

integer

projected_spend

number format: float

status

string

Allowed values: on_track near_limit over_budget forecast_breach

client_generated_id

string

nullable

last_synced_at

string format: date-time

nullable

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string format: date-time

nullable

Example

{
  "data": [
    {
      "owner_type": "App\\Models\\User",
      "currency": "USD",
      "period_type": "weekly",
      "threshold_percent": 80,
      "targets": [
        {
          "type": "category"
        }
      ],
      "progress": {
        "status": "on_track"
      }
    }
  ]
}

401

Unauthenticated