Budget View Snapshots API
The Budget View Snapshots API allows you to retrieve a list of budget view snapshots for a specific project. Snapshots represent the state of a budget view at a particular point in time.
Get Budget View Snapshots
GET
/api/external/budget-view-snapshotscurl -X GET "https://api.kurrent.com/api/external/budget-view-snapshots?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 view snapshots.
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 snapshot objects.
Example Response
{
"data": [
{
"id": 789,
"name": "End of January 2025",
"description": "Budget snapshot at the end of January 2025",
"created_at": "2025-01-31T23:59:59Z",
"budget_view_id": 123,
"project_id": 456,
"created_by": {
"id": 101,
"name": "John Doe",
"email": "john.doe@example.com"
}
},
{
"id": 790,
"name": "End of February 2025",
"description": "Budget snapshot at the end of February 2025",
"created_at": "2025-02-28T23:59:59Z",
"budget_view_id": 123,
"project_id": 456,
"created_by": {
"id": 101,
"name": "John Doe",
"email": "john.doe@example.com"
}
}
]
}
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.