ActiveManage Docs ← Back to activemanage.co.uk

API Overview

The ActiveManage REST API exposes the platform's data and actions to scripts, integrations, mobile apps and other services. If a feature is available in the UI, there's almost always an API equivalent — and the API is the right surface for everything that's not a manual click.

Diagram showing external clients (web app, mobile, integrations, scripts) calling the API gateway, which dispatches to authentication, rate limiter, business logic and storage layers

What the API Provides

  • CRUD on every datastore — list, create, read, update, delete records.
  • Authentication — sign users in, refresh tokens, sign out.
  • Search — full-text, faceted and filtered queries.
  • Workflow actions — trigger business actions (submit form, approve record, send email).
  • File upload/download — manage attachments and the file store.
  • Admin operations — create users, modify groups, configure tenants (restricted to admin tokens).
  • Webhooks — register URLs to be called on events.

Conventions

  • REST: GET retrieves, POST creates, PATCH updates, DELETE removes.
  • JSON in / JSON out: application/json for both directions.
  • Cursor pagination: list endpoints return { data: [...], nextCursor: 'abc' }.
  • ISO-8601 dates: in UTC unless explicitly timezoned.
  • Versioning: /api/v1/…. Breaking changes increment the version; current is v1.

Typical Use Cases

  • Mobile app: Native iOS/Android consumes the API for everything users do.
  • Salesforce integration: Nightly sync of customers and orders.
  • Data warehouse: Pull all records into BigQuery for analytics.
  • Slack notifications: Webhook fires on order creation, posts to a channel.
  • Custom scripts: Bulk import, batch delete, scheduled cleanups.