List closed-period snapshots for rollover-enabled budgets
GET
/budget-period-states
const url = 'http://localhost:8000/api/v1/budget-period-states?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/budget-period-states?limit=20' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” limit
integer
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
Section titled “ Responses ”Period states visible to the user
Media type application/json
object
data
Array<object>
object
id
integer
budget_id
integer
period_start
string format: date
period_end
string format: date
net_spent
number format: float
rollover_in
number format: float
rollover_out
number format: float
closed_at
string format: date-time
client_generated_id
string
last_synced_at
string format: date-time
created_at
string format: date-time
updated_at
string format: date-time
Example generated
{ "data": [ { "id": 1, "budget_id": 1, "period_start": "2026-04-15", "period_end": "2026-04-15", "net_spent": 1, "rollover_in": 1, "rollover_out": 1, "closed_at": "2026-04-15T12:00:00Z", "client_generated_id": "example", "last_synced_at": "2026-04-15T12:00:00Z", "created_at": "2026-04-15T12:00:00Z", "updated_at": "2026-04-15T12:00:00Z" } ]}