Budget Views API

The Budget Views API allows you to retrieve budget views for a specific project. Budget views provide structured financial data about a project's budget.

Get Budget Views

GET

/api/external/budget-views

curl -X GET "https://api.kurrent.com/api/external/budget-views?project_id=123" \
  -H "x-api-key: your-api-key" \
  -H "x-organization-id: your-organization-id" \
  -H "x-company-id: your-company-id"

Query Parameters

Name
project_id
Type
integer
Required
Description
The ID of the project for which to retrieve budget views.

Required Headers

Name
x-api-key
Type
string
Required
Description
Your API key for authentication.
Name
x-organization-id
Type
string
Required
Description
The ID of your organization.
Name
x-company-id
Type
string
Required
Description
The ID of the company you're accessing.

Response

dataarray

An array of budget view objects.

Example Response

{
  "data": [
    {
      "id": 123,
      "name": "Q1 2025 Budget View",
      "description": "Budget view for Q1 2025",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-15T12:30:45Z",
      "project_id": 456
    },
    {
      "id": 124,
      "name": "Q2 2025 Budget View",
      "description": "Budget view for Q2 2025",
      "created_at": "2025-04-01T00:00:00Z",
      "updated_at": "2025-04-10T09:15:30Z",
      "project_id": 456
    }
  ]
}

Error Responses

errorstring

A description of the error that occurred.

Example Error Response

{
  "error": "project_id is required in query parameters"
}

Status Codes

Name
200
Description
The request was successful.
Name
400
Description
Bad request - check the error message for details.
Name
401
Description
Unauthorized - invalid or missing API key.
Name
404
Description
Not found - the organization or project was not found.
Name
500
Description
Internal server error.

Budget View Snapshots API

Budget View Snapshot API