canonical: https://jentic.com/apis/learnifier.com/learnifier-learnifier

# Learnifier

The Learnifier API exposes a multi-tenant corporate learning platform organised around organisation units, projects, and participants. Agents can manage organisation units and their nested projects, add and activate participants, generate participant login links, manage user groups at both organisation and global level, and read course design templates that seed new projects. The surface is broad enough to automate enrolment, group membership, and project provisioning for client training programmes without manual UI work.

## For AI agents

Provision Learnifier organisation units and training projects, add and activate participants, manage user groups, and generate participant login links for corporate learning programmes.

## Scope

Does not handle content authoring, video streaming, or payment collection - use for tenant, project, participant, and group management on Learnifier only.

## Capabilities

- Provision new organisation units and update existing ones for client tenants
- Create and update training projects under an organisation unit and seed them from course design templates
- Add, activate, and remove participants on a specific project for cohort-based delivery
- Generate one-time login links so participants can access a project without a separate sign-up flow
- Manage user groups at organisation and global level to control who sees which content
- Look up users and projects by external ID for clean integration with an HRIS or CRM

## Use cases

### Automated Cohort Enrolment From an HRIS

Push new hires from an HRIS into the matching Learnifier training project automatically. The agent looks up the project by external ID, posts the participant via `/orgunits/{orgid}/projects/{projectid}/participants`, then activates the participant so the welcome email goes out. Replaces a manual ticket queue between HR and L&D ops.

Example prompt: On HRIS new-hire event, GET /extproject by external ID, POST a participant on `/orgunits/{orgid}/projects/{projectid}/participants`, then POST to /activate.

### Client Tenant Provisioning

Spin up a new client tenant including its organisation unit, a starter project from a course design template, and an initial admin user. The agent posts a new org unit, lists course design templates, creates a project under that org unit, and adds the admin user - all in one workflow. Compresses a multi-step manual setup into one orchestration.

Example prompt: POST /orgunits with the client name, GET /coursedesigns and pick a template, POST `/orgunits/{orgid}/projects`, then POST `/orgunits/{orgid}/projects/{projectid}/participants` for the admin.

### Participant Login Link Distribution

Send participants a deep link straight into their project rather than asking them to remember credentials. The agent generates a login link via `/participants/{participantId}/loginlink` and emails it to the learner with the project name. Reduces support tickets caused by forgotten passwords on an infrequently used training portal.

Example prompt: POST `/orgunits/{orgid}/projects/{projectid}/participants/{participantId}/loginlink`, then send the returned URL to the participant by email.

### AI Agent L&D Operator via Jentic

An L&D operator uses an AI agent built on Jentic to add, activate, and link participants for a new cohort with a single instruction. Jentic resolves the right Learnifier operation, sequences the participant POST and activate, and returns a confirmation list to the operator without them touching the API directly.

Example prompt: Through Jentic, search 'add learnifier participant', execute the participant POST for each learner in the cohort, then chain to activate.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/orgunits` | Create an organisation unit |
| POST | `/orgunits/{orgid}/projects` | Create a training project under an org unit |
| POST | `/orgunits/{orgid}/projects/{projectid}/participants` | Add a participant to a project |
| POST | `/orgunits/{orgid}/projects/{projectid}/participants/${participantId}/activate` | Activate a participant on a project |
| POST | `/orgunits/{orgid}/projects/{projectid}/participants/${participantId}/loginlink` | Generate a participant login link |
| GET | `/coursedesigns` | List global course design templates |
| GET | `/users` | List users on the platform |

## Key resources

- **Organisation Units** — Top-level tenant containers with nested projects and user groups
- **Projects** — Training project instances under an organisation unit, seeded from course designs
- **Participants** — Learners added to a specific project with activation and login link operations
- **Users** — Platform users including team members and learners with profile data
- **User Groups** — Organisation-level and global groups for content visibility and assignment
- **Course Designs** — Reusable course design templates that seed new projects

## Why Jentic

- **Setup:** Wiring the Learnifier API by hand means attaching its API key to each request, targeting the learnifier.com host, and threading the orgunit, project, and participant paths yourself. Through Jentic you install once, import Learnifier from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Learnifier puts the orgunit id in the URL path (`/orgunits/{orgid}/...`), so a rule can pin your agent to one orgunit: it can manage projects and participants within that orgunit and nothing else. You choose the operations it may call, so activating a participant or issuing a login link is included only if you add it.
- **Credential handling:** Your Learnifier API key is stored once, encrypted, by your own Jentic One instance and added to the request at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'add a Learnifier participant' or 'generate a learner login link', and Jentic returns the matching Learnifier operation with its input schema so the agent calls the right endpoint without scanning the paths by hand.

## Related APIs

- **TalentLMS API** — TalentLMS is a comparable corporate LMS with course, user, and enrolment APIs.
- **Moodle API** — Moodle is the open-source LMS counterpart with broad course and enrolment coverage.
- **BambooHR API** — BambooHR provides the canonical employee list that drives Learnifier enrolment.

## FAQ

### What authentication does the Learnifier API use?

The Learnifier swagger advertises no formal security scheme - endpoints expect an API key supplied as a query parameter, as seen in the user profile picture endpoint. Through Jentic, that key is stored encrypted in the credential vault and added to outgoing requests at execution time, so it never enters the agent context.

### Can I create training projects and add participants through the Learnifier API?

Yes. POST `/orgunits/{orgid}/projects` creates a project under an organisation unit, then POST `/orgunits/{orgid}/projects/{projectid}/participants` adds a participant, and POST .../participants/{participantId}/activate activates them so the welcome flow runs.

### What are the rate limits for the Learnifier API?

Rate limits are not declared in the OpenAPI spec. Provisioning workflows that touch organisation units and projects should run sequentially with backoff rather than parallel bursts to avoid clashing on tenant setup.

### How do I generate a learner login link through Jentic?

Run `pip install jentic`, search 'generate learnifier login link', and execute POST `/orgunits/{orgid}/projects/{projectid}/participants/{participantId}/loginlink.` Jentic returns the link payload ready to email or paste into a downstream notification.

### Can I look up Learnifier records by external ID?

Yes. GET /extorgunit, /extproject, /extuser, and /extparticipation each accept an external ID query, which is the right pattern when integrating with an HRIS or CRM that already owns the canonical IDs.

### Is the Learnifier API free?

API access is included with Learnifier subscription tiers rather than sold separately. Check learnifier.com pricing for the plan that includes API access for your tenant.

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

Yes. Because you run Jentic One yourself, your own rules decide which Learnifier operations and credentials the agent may use. Since the orgunit id sits in the URL path (`/orgunits/{orgid}/...`), a rule can pin the agent to a single orgunit so it can manage only the projects and participants within that tenant. You also choose the exact operations it may call, so activating a participant or generating a login link is available only if you add it.