List budgets

GEThttps://<your-url>/api/v2/budgets

MCP id budgets.indexAlso on this path: POST Create a budget

Returns the organisation's budgets, lowest position first, each with the number of kanban tasks the caller may see.

Token scope: api:read:budgets
Without it: 403 insufficient-token-scope.
Permission: budgets::read
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: q +2.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One project's open budgets

curl -G \
  'https://<your-url>/api/v2/budgets' \
  --data-urlencode 'filter[project_id]=1' \
  --data-urlencode 'filter[is_open]=true' \
  --data-urlencode 'sort=order_column' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/budgets?filter[project_id]=1&filter[is_open]=true&sort=order_column', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/budgets?filter[project_id]=1&filter[is_open]=true&sort=order_column');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/budgets?filter[project_id]=1&filter[is_open]=true&sort=order_column',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "project_id": 1,
      "budget_group_id": 1,
      "order_column": 1,
      "description": "Front-end development",
      "start_date": "2026-03-04",
      "end_date": "2026-03-04",
      "budget": 4800,
      "spendable": 4200,
      "status": "active",
      "is_open": false,
      "is_billable": true
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

6 more fields, listed under Response

There is no projects/{project}/budgets path: pass filter[project_id] to read one project's budgets, or filter[budget_group_id] to read one group's. Positions are numbered across the whole organisation and renumbered per project in plnnrly, so a page spanning several projects interleaves and ties break by id. Pass view=detail for the full payload at three read units instead of one; the two views are identical on this resource.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

30 parameters in 5 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request. This collection's default sort is a display position that changes whenever someone drags the list into a new order in plnnrly, so a page number can skip or repeat a row if the list is reordered between two page requests. These collections rarely exceed one page; for a stable walk, send sort=id and follow links.next without page.

Filters

=: equals
[in]: any of a comma-separated list
[null]: true or false: whether it is empty
[gte][lte][lt]: at least, at most, less than
[ne]: not equal

filter[budget_group_id]integer=[in][null]

Budget group the budget is filed under.

A comma-separated list of at most 100 values.

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[end_date]date (YYYY-MM-DD)=[gte][lte][null]

Last day the budget covers.

Whether the field is null.

filter[is_billable]boolean

Whether time logged on this budget is billable.

filter[is_open]boolean

Whether the budget is open-ended, i.e. its spendable cap is ignored and the over-budget warning is skipped.

filter[project_id]integer=[in]

Owning project.

A comma-separated list of at most 100 values.

filter[start_date]date (YYYY-MM-DD)=[gte][lte][null]

First day the budget covers.

Whether the field is null.

filter[status]string=[ne][in]

Lifecycle status of the budget.

A comma-separated list of at most 100 values.

activeinactiveblocked

New values may be added.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

Search

qstring

Free-text search over description. At most one substring match per request: q together with a contains filter is 400 invalid-query-parameter.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: order_column

Key	Sorts by
`order_column`	Position within the project as arranged in plnnrly, lowest first. The values are numbered across the whole organisation and renumbered per project, so a page of budgets from several projects interleaves and ties are broken by id.
`start_date`	First day the budget covers.
`end_date`	Last day the budget covers.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a page of BudgetList rows.

dataarray of BudgetList

The rows, each a BudgetList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a BudgetList: 18 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning