Developer REST API

ActivoHQ exposes a REST API at /api/v1 so you can integrate fixed-asset data with your own systems, automate bulk updates, or build custom dashboards. This page covers every endpoint available in Phase 1.

API reference

• Assets & Companies - CRUD for companies and assets, write payload, and read-only computed fields.
• Lookups & Master Data - GET and POST/PUT for categories, locations, cost-centers, depreciation-books, custodians, and employees.
• Accounting - Read-only access to fiscal years, depreciation runs/entries, journal batches, disposals, and revaluations.
• Audit & Lifecycle - Read-only count sessions, count results, transfers, checkouts, and reservations - plus lifecycle action POSTs.

Base URL

https://{tenant}.activohq.cloud/api/v1

Replace {tenant} with your subdomain (e.g. acme -> https://acme.activohq.cloud/api/v1). All requests are scoped to the tenant identified by the host header; there is no tenant segment in the path.

Authentication

Every /api/v1 request must carry an API key in the X-Api-Key header.

X-Api-Key: ahq_your_key_here

How to get a key: sign in as an Administrator, open Profile -> Developer API, and click Generate. Copy the key (it is shown only once after generation). To rotate a leaked key use Regenerate; to disable access use Revoke.

A missing or invalid key returns:

HTTP 401 Unauthorized

Company scope

Every endpoint except GET /api/v1/companies requires a companyId query parameter. Get your company ids from GET /api/v1/companies.

Pagination

List endpoints accept skip (default 0) and take (default 50, max 200) and return a standard envelope:

{
  "items": [...],
  "total": 312,
  "skip": 0,
  "take": 50
}

Walk through a full result set by incrementing skip by take until skip >= total.

Error shape

All errors return a non-2xx status and a small JSON body:

{ "error": "Human-readable message." }

Typical integration flow

1. Call GET /api/v1/companies to obtain your companyId.
2. Call the lookup endpoints (/categories, /locations, etc.) to map codes to ids.
3. POST /api/v1/assets for each new asset.
4. PUT /api/v1/assets/{id} to update existing ones.
5. GET /api/v1/assets?search=... to query the register.

Questions and support

Contact support@activohq.cloud or your ActivoHQ administrator. Include the request id (from the response) and the exact payload you sent.