canonical: https://jentic.com/apis/getadministrate.com/administrate

# Getadministrate Administrate DMS API

Jentic publishes the only available OpenAPI specification for Administrate DMS API, keeping it validated and agent-ready. Administrate is a training management platform for corporate learning and external training providers, and the DMS (Document Management System) API is its legacy interface for retrieving documents attached to courses, events, or learners. The current API exposes a single read endpoint for fetching a document by ID. Note: this API is deprecated and scheduled for retirement, so production agents should plan a migration to Administrate's newer GraphQL platform.

## For AI agents

Retrieve a document file from the Administrate Document Management System by ID. The endpoint is read-only and exposes one operation; the API is deprecated, so use it only for legacy integrations.

## Scope

Does not handle course management, learner enrolment, or document upload - use only for read-by-ID retrieval of legacy DMS documents during migration or audit workflows.

## Capabilities

- Retrieve a single DMS document by its identifier for legacy training-record exports
- Pull historical course attachments out of Administrate during a migration to the newer GraphQL API
- Mirror legacy training documents into a separate document store before the DMS retires
- Verify a stored document ID still resolves before decommissioning a training catalogue entry

## Use cases

### Legacy Document Retrieval

Training providers running long-lived Administrate accounts often hold thousands of attachments in the legacy DMS. The API's single endpoint allows automated retrieval of a document by ID so historical records can be exported during audits or system migrations. Each call returns one document, so retrieval is typically driven by a list of IDs collected elsewhere.

Example prompt: Given a list of DMS document IDs from a CSV, call `GET /api/v2/docs/dms/{id}` for each ID and store the returned file in a destination bucket.

### Pre-Migration Document Mirror

Organisations migrating from the deprecated DMS to Administrate's newer platform need a verified copy of every existing document before the legacy endpoint retires. The DMS API supplies the binary content per document, allowing a one-time mirror into another document store keyed by Administrate ID.

Example prompt: Iterate over a manifest of DMS IDs, call `GET /api/v2/docs/dms/{id}` for each, and write the file plus its metadata to a backup location.

### Audit-Driven Spot Check

When auditors request a specific training certificate or course attachment, the DMS API can fetch it on demand without exposing a human user to the Administrate console. The single document endpoint is sufficient for ad-hoc retrieval during compliance reviews.

Example prompt: Given a document ID supplied by an auditor, call `GET /api/v2/docs/dms/{id}` and return the file contents as the audit response.

### Agent-Driven Legacy Lookup

An AI agent helping a learning operations team answer document-recovery questions can use Jentic to discover the DMS retrieval operation and fetch any document by ID without manual API plumbing. Because the API is deprecated, the agent should also flag results so the team can plan migration off the endpoint.

Example prompt: Resolve a learner's request for a specific certificate by calling the DMS document endpoint via Jentic and returning the file along with a deprecation notice for the operations team.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/v2/docs/dms/{id} | Get a DMS document by ID |

## Key resources

- **Documents** — Legacy DMS documents - single read-by-ID endpoint.

## Why Jentic

- **Setup:** Wiring the Administrate DMS API by hand means setting up basic auth, building the Authorization header, and following the deprecated document-retrieval conventions yourself. Through Jentic you install once, import Administrate from the API Directory, store the username and password once, and your agent calls it.
- **Permission scoping:** Administrate puts the document id in the URL path (/api/v2/docs/dms/{id}), so a rule can pin your agent to reading one document by id and nothing else. You choose the operations it may call, and only the read-by-id retrieval is exposed here, so nothing beyond it runs.
- **Credential handling:** Your Administrate username and password are stored once, encrypted, by your own Jentic One instance, and the Authorization header is built at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'retrieve a legacy training document from Administrate', and Jentic returns the DMS document operation with its input schema so the agent calls it without reading the deprecated docs.

## Related APIs

- **Contentful** — Headless content platform that can host training documents in a structured, modern API surface.
- **Sanity** — Structured content backend suitable as a destination for documents migrated off Administrate DMS.
- **Storyblok** — Headless CMS often paired with training platforms to publish course descriptions and marketing content.

## FAQ

### Why is there no official OpenAPI spec for Administrate DMS API?

Administrate does not publish a current OpenAPI specification for the legacy DMS endpoint. Jentic generates and maintains this spec so that AI agents and developers can call Administrate DMS API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Administrate DMS API use?

The DMS API uses HTTP Basic Authentication. Through Jentic, the credential pair is stored encrypted and injected at execution time - agents never receive the raw username and password.

### Can I retrieve any document by ID with the Administrate DMS API?

Yes, but only one document per call. Use `GET /api/v2/docs/dms/{id}` to fetch a single document. To export many, iterate over a list of IDs collected from elsewhere.

### How do I retrieve a DMS document through Jentic?

Search Jentic for `retrieve a document from Administrate DMS`, load the schema for `GET /api/v2/docs/dms/{id}`, and execute with the document ID. Jentic injects the Basic Auth header from the vault.

### Is the Administrate DMS API still supported?

No - Administrate marks this API as deprecated and scheduled for retirement. Use it for legacy retrieval and migration only, and plan to move to Administrate's newer platform for ongoing integrations.

### Does this API let me upload documents to Administrate?

No. The DMS API surface here is read-only and exposes a single GET-by-ID endpoint. For upload or course management, use Administrate's primary platform API.

### Can I limit what my agent is allowed to do with the Administrate DMS API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. This API exposes only the read-by-ID retrieval (GET /api/v2/docs/dms/{id}), which puts the document id in the URL path, so a rule can pin your agent to fetching one document by id and nothing else. You control the operations it may call, and since no upload, course-management, or write operations are exposed here, nothing beyond the single document read can run.