Finance · Accounting · Budgets
List budgets
Lists budgets for an organization and a specified mandate, or for all mandates when mandateId is null. Returns budget details ordered by newest fiscal year first.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Requires organization access.
- Requires
mandate.read. - Requires
budget.read. - An approver other than a contact is masked without
user.read, unless it is the current actor. API approvers are also subject to theapiKey.readcheck. - An API approver is masked without
apiKey.read.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/list' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/list", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/budgets/list', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
budgetsobject[]6 properties
-
_idid -
mandateid -
fiscalYearinteger2000–3000
-
statusstringdraftapproved -
approvedAtstring · date-timenullable -
approvedByobjectnullable
-
More about the fields
budgets[].approvedBy.name: A masked approver's name is replaced with the localized no-permission name.budgets[].approvedBy.image: When a user approver is masked but the field must retain a user actor, its image is null.
Response200
{
"budgets": [
{
"_id": "000000000000000000000001",
"mandate": "000000000000000000000001",
"fiscalYear": 2000,
"status": "draft",
"approvedAt": "2026-06-15T22:30:00Z",
"approvedBy": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
}
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.