List all budgets

Returns a list of all budgets on an account. Ordered alphabetically.

Use the include parameter to return optional information such as available, pending, and ledger balances.

SecurityCommonAuth
Request
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50072
limit
integer <int32> (limit) [ 1 .. 1000 ]
Default: 100

The maximum number of budgets to return.

Example: limit=100
offset
integer <int32> (offset)
Default: 0

The number of budgets to skip before returning results.

Example: offset=200
budgetId
Array of strings <uuid> (budgetId)

The ID of the budget to work with. Use commas to pass multiple values. Has to be URL encoded.

Example: budgetId=56%2C111
include
Array of any

Optional embeds to include when returning the budgets.

Items Enum: "balance" "budgetHierarchy" "settlementDetails"
Example: include=balance
search
string <= 100 characters

The term to filter results by.

Example: search=Marketing
type
string

The type of budget to filter results by.

Enum: "accountBalance" "shared" "individual" "forwardDeposits"
Example: type=shared
currencyCode
string (currencyCode) ^[A-Z]{3}$

The currency code, in ISO-4217 format.

Example: currencyCode=USD
personId
string <uuid> (personId) <= 36 characters

The ID of the person to work with.

Example: personId=b489ea2c-0dd1-4fb1-b345-de5a596a5529
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/budgets
Request samples 
Response samples 
application/json
{
  • "limit": 100,
  • "offset": 200,
  • "count": 67,
  • "rows": [
    ]
}