REST and GraphQL API integration
Yes. Personal Academy has a versioned v1 REST API, described in a generated OpenAPI document, and a GraphQL endpoint. Organisation API keys are hashed, scoped by module and checked against live permissions. Idempotency-Key is honoured on AI, authoring, certificate and commerce POSTs. Keys cannot yet be given an expiry or rotated from the admin screen, and user, enrolment and tenant POSTs do not yet take an Idempotency-Key.
See pricing (from $1 per active user)
Included from the Basic plan, $1 per active user per month.
At a glance
The API covers learning, assessment, development, engagement, organisation and governance data. The OpenAPI document and an interactive reference are served from the API itself.
| Status | Built and verified |
|---|---|
| Included from | Basic plan (API) |
| Authentication | Hashed, scoped organisation API keys |
| Data that flows | In and out: courses, enrolments, people, groups, assessments and more |
| Not yet | Key expiry and rotation in the admin screen; Idempotency-Key on user, enrolment and tenant POSTs |
How to set it up
- Open API keys in the Personal Academy admin area and create a key with the scopes you need.
- Copy the key, shown once, into your client as a Bearer token.
- Read the OpenAPI document at /api/v1/openapi.json and make a first GET request.
Highlights
- v1 REST API with a generated OpenAPI document
- GraphQL endpoint
- Scoped API keys with live permission checks
- Cursor pagination and rate-limit headers
Technical overview
Authentication:Organisation API key (Authorization: Bearer)
Setup Time:~10 minutes
Prerequisites:
- •An administrator who can create API keys.