Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Budgets

POST/{organizationId}/{mandateId}/finance/accounting/budgets/listReads only

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 the apiKey.read check.
  • 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'

Response

200 Successful response

Content-Type: application/json

  • budgetsobject[]
    6 properties
    • _idid
    • mandateid
    • fiscalYearinteger

      2000–3000

    • statusstring
      draft approved
    • 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.