ActiveManage Docs ← Back to activemanage.co.uk

Available Endpoints

Every entity and action in ActiveManage is reachable through a REST endpoint. This article gives an overview of the endpoint families and links to per-family detail pages.

Tree view of API endpoints organised by namespace: /auth/*, /users/*, /tables/*, /records/*, /files/*, /workflows/*, /webhooks/*, /admin/*, with sub-endpoints listed under each

Endpoint Families

  • /auth/* — sign in, refresh tokens, sign out, MFA challenges, password reset.
  • /users/* — user CRUD, profile updates, preferences, password change.
  • /tables/* — datastore management, schema introspection.
  • /records/{table}/* — records inside a datastore (list, get, create, update, delete).
  • /files/* — upload, download, list, delete file store attachments.
  • /workflows/* — trigger named workflows (custom business actions).
  • /webhooks/* — manage outbound webhook subscriptions.
  • /notifications/* — send and receive notification events.
  • /admin/* — tenant, group, permission, billing admin (requires admin scope).
  • /search/* — full-text and structured search.

Common Endpoint Patterns

  • GET /records/orders — list orders.
  • GET /records/orders/{id} — get one order.
  • POST /records/orders — create.
  • PATCH /records/orders/{id} — partial update.
  • DELETE /records/orders/{id} — soft delete.
  • POST /workflows/orders/{id}/approve — run a workflow action.

Discovering the Schema

Hit GET /tables/{name} to introspect the columns, types and validation rules of any datastore. This lets dynamic clients adapt to schema changes without redeploying.

OpenAPI

A complete OpenAPI 3 spec is available at /api/openapi.json. Use it to generate client SDKs in any language — TypeScript, Python, Go, C#, Ruby.