The Allocadia REST API — overview of endpoints

The Allocadia REST API (v1) exposes endpoints for budgets, line items, PRs, transfers, users, and more. Here's the lay of the land.

Base URL

• North America: https://api-na.allocadia.com/v1
• Europe: https://api-eu.allocadia.com/v1

Each request appends an operation onto the base URL.

Major resource groups

• Authentication — POST /token
• Budgets — GET /budgets, GET /budgets/{id}, POST /budgets/{id}/users
• Line Items — GET, POST, PUT, DELETE on /lineitems and /budgets/{id}/lineitems
• Columns & Column Choices — read and manage custom-field definitions
• Financials — GET /financials
• Forecast Tags and Scenarios — read, modify, delete
• Target Transfers — create, read, modify, delete transfer requests
• Users and Roles — read and modify users; read roles
• Jobs — fetch async-job status and results
• Activities (V11, Early Access) — Plan-side activities, activity types, attributes

A full endpoint list is in the public API documentation.

Request/response format

• JSON for both request and response bodies.
• Set Content-Type: application/json and Accept: application/json.
• Timestamps are ISO-8601 UTC with fractional seconds — see What format are timestamps in Allocadia API responses?
• Successful responses: 200 (fetch), 201 (create — see Location header for new resource URL), 202 (async accepted), 204 (update/delete).

HATEOAS links

GET responses include a _links block with URLs to related resources. For example, a Line Item response includes links to itself and its parent Budget. Use these links programmatically where possible instead of hardcoding URLs — it makes your integration more robust against future changes.

Filtering with $filter

List endpoints support a $filter query parameter for narrowing results. Supported operators: eq, ne, gt, ge, lt, le, and, or, contains.

Example: updatedDate ge "2026-01-01T00:00:00.000Z" and updatedDate lt "2026-02-01T00:00:00.000Z"

Filter on sub-properties and custom attributes too — see the public API docs for syntax.

Related articles

• REST API authentication in Allocadia (bearer token, 20-minute timeout)
• Deleting records via the Allocadia API — what to know first
• Allocadia API requests returning HTTP 429 — too many requests
• What format are timestamps in Allocadia API responses?