Skip to content
P4 Software P4 Software / activoHQ English

Add these docs to Claude

Ask Claude questions about these docs. Claude reads the published pages and links you back to them. Copy this address:

https://p4-software.opendocs.page/mcp

In claude.ai or Claude Desktop: open Settings, then Connectors, choose Add custom connector and paste the address.

In Claude Code, run:

claude mcp add --transport http docs https://p4-software.opendocs.page/mcp

Developer API

REST API for developers (overview)

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


Base URL

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

Replace {tenant} with your subdomain (for example acme -> https://acme.activohq.cloud/api/v1). Every request is scoped to the tenant identified by the host header; there is no tenant segment in the path.


Authentication

Every request to /api/v1 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 My profile, find the Developer API box and click Generate API key. The key stays saved in that box: use the eye icon to reveal or hide it and Copy to clipboard to copy it. Keys do not expire. To rotate a compromised key use Regenerate; to disable access use Revoke. The box also has a View API reference link, which opens the interactive reference at /developers on your domain.

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.

Error Cause
400 The parameter is absent or is not a valid GUID. In that case the response does not carry the API's error body. If the empty GUID (all zeros) is sent, the body is {"error":"companyId is required."}.
404 {"error":"Company not found."} The ID matches no active company in your tenant.

Paging

List endpoints accept skip (default 0) and take (default 50, minimum 1, maximum 200; out-of-range values are adjusted) and return a standard envelope:

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

Walk the full result set by incrementing skip by the value of take until skip >= total.


Error shape

The API's errors return a non-2xx status and a small JSON body (messages are in English):

{ "error": "Human-readable message." }
Status Meaning
400 Validation failed, or a business rule was broken. If the request is malformed (for example a missing companyId, or a body that is not valid JSON), the response may not carry the error body.
401 X-Api-Key missing or invalid. It has no body.
404 Resource not found.

A typical integration flow

  1. Call GET /api/v1/Companies to get your companyId.
  2. Call the catalog endpoints (/Locations, /cost-centers and so on) to map codes to IDs.
  3. POST /api/v1/Assets for each new asset. The asset model (assetModelId) has no catalog of its own: take it from an existing asset's model.id.
  4. PUT /api/v1/Assets/{id} to update existing ones. The PUT replaces the whole record: read the asset first with GET and send back every field, because the ones you leave out are cleared.
  5. GET /api/v1/Assets?search=... to query the register.

Questions and support

Contact support@activohq.cloud or your activoHQ instance's administrator. Include the route, the date and time of the call, the HTTP status you received and the exact payload you sent (the API does not return a request ID).

Was this page helpful?