Read a budget

GEThttps://<your-url>/api/v2/budgets/{budget}

MCP id budgets.showAlso on this path: PATCH Update a budget, DELETE Delete a budget

Returns one budget with its project, its budget group and the number of kanban tasks the caller may see, plus a link to that filtered task collection. budget and spendable are minutes, not money.

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.
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 budget

curl -X GET \
  'https://<your-url>/api/v2/budgets/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/budgets/1', {
  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/1');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/budgets/1',
    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
  }
}

6 more fields, listed under Response

Path parameters

budgetintegerRequired

The Budget's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

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 Budget in the detail view.

Headers

ETag: A strong validator of exactly this representation.
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