Skip to main content
GET
List budgets

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
number
default:1

Page number

Required range: x >= 1
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
sortColumn
enum<string>
default:created_at

Field to sort by

Available options:
title,
fiscal_year,
fiscalYear,
status,
period_type,
periodType,
created_at,
createdAt,
updated_at,
updatedAt
sortDesc
boolean | null
default:true

Sort descending

Search in budget title

Maximum string length: 255
companyId
string<uuid>

Filter by company ID

fiscalYear
number

Filter by fiscal year

Required range: 1900 <= x <= 2100
status
enum<string>

Filter by status

Available options:
Draft,
PendingApproval,
Approved,
Obsolete
periodType
enum<string>

Filter by period type

Available options:
Annual,
Quarterly,
Monthly

Response

List of budgets

data
object[]
required

Array of budgets

pagination
object
required