Northpass API
37
AI ReadinessNon-Ready (F)37/100
Agent-ready OpenAPI document · curated by JenticEducationLmsapiKey81 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Manage learners, courses, learning paths, assignments, certificates, and groups in a Northpass customer academy. Supports bulk enrollment and HRIS sync.
Use for: I want to enroll a customer in a Northpass onboarding course, Bulk add 200 new hires from BambooHR into our partner academy, List all learners who completed the certification course this month, Issue a completion certificate to a learner who finished a learning path
Not supported: Does not handle live video classes, payment processing, or HRIS source-of-truth - use for customer and partner academy delivery only.
Jentic publishes the only available OpenAPI specification for Northpass API, keeping it validated and agent-ready. Northpass is a customer education platform for delivering branded learning portals, courses, learning paths, and certifications to customers and partners. The API exposes 81 endpoints covering courses, learning paths, assignments, groups, people, certificates, custom domains, and bulk enrollment, plus integrations with HRIS systems like BambooHR. It supports the operational work of running a customer academy, including learner provisioning, progress tracking, and reporting on activity.
Install Jentic One Beta
Connect the Northpass API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Northpass API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnorthpass.com%2Fnorthpass" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnorthpass.com%2Fnorthpass" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Northpass API.
Enroll learners into courses and learning paths individually or in bulk
Create and manage groups, group memberships, and group-scoped course access
Issue and revoke completion certificates tied to learner profiles
Sync employees from BambooHR into the academy as learners
Track learner activity, course progress, and assignment submissions
Manage custom email templates and email domains for academy notifications
Use Cases
Patterns agents use Northpass API for, with concrete tasks.
★ Customer Onboarding Academy
Provision new customers into a branded learning portal and track their progress through onboarding modules. Northpass handles enrollment, course delivery, and certificate issuance, so success teams can confirm activation milestones without manual chasing. Bulk endpoints let an integration enroll cohorts of hundreds of customers in a single call rather than per-user requests.
Bulk enroll 50 new customer email addresses into the Product Fundamentals learning path and confirm each enrollment succeeded
Partner Certification Programme
Deliver a structured certification track to channel partners with assignments, exams, and certificate issuance on completion. The API exposes assignments, submissions, and certificates, letting an external system pull pass/fail outcomes and feed them into a partner portal. Issued certificates can be retrieved and embedded in downstream profile pages.
List assignment submissions for the Reseller Certification course, mark passing scores, and issue certificates to learners who scored above 80
HRIS-Driven Internal Training
Auto-provision employees from BambooHR into Northpass groups based on department, then assign role-specific courses. The BambooHR app endpoints control the sync configuration, and bulk group endpoints handle the membership churn that comes with new hires and role changes. This removes manual roster maintenance for L&D teams.
Update the BambooHR sync to add the Engineering department, then bulk-add new engineers to the Security Awareness group
AI Agent Learner Support
An AI agent embedded in a help portal answers learner questions about course progress and next steps. Through Jentic, the agent searches for the right Northpass operation, loads the schema, and calls endpoints like list activities or fetch a learning path to ground its answers in live data rather than hallucinating progress information.
Look up a learner's current course progress and outstanding assignments, then summarise next recommended steps
Key Endpoints
81 endpoints — jentic publishes the only available openapi specification for northpass api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/v2/people
List learners in the academy
POST
/v2/bulk/people/membership
Bulk add people to groups
GET
/v2/assignments
List all assignments
GET
/v2/assignments/{assignment_uuid}/submissions
List submissions for an assignment
POST
/v2/bulk/groups
Bulk create groups for a school
GET
/v2/activities
List learner activities
PUT
/v2/apps/bamboo_hr
Update BambooHR integration configuration
GET
/v2/people
List learners in the academy
POST
/v2/bulk/people/membership
Bulk add people to groups
GET
/v2/assignments
List all assignments
GET
/v2/assignments/{assignment_uuid}/submissions
List submissions for an assignment
POST
/v2/bulk/groups
Bulk create groups for a school
GET
/v2/activities
List learner activities
PUT
/v2/apps/bamboo_hr
Update BambooHR integration configuration
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
N
Northpass API
- Non-Ready (F)37/100
46
Foundational Compliance66
Developer Experience & Jentic Compatibility16
AI-Readiness & Agent Experience89
Agent Usability50
Security63
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
46
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: DSignals: 4
85%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
66
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
14%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
16
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
26%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
12%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
26%
Summary Coverage
Coverage of summaries across operations/tags/info.
89
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: ASignals: 1
89%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
63
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: BSignals: 1
63%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Northpass by hand means setting up its API-key header against api.northpass.com and threading it through people, assignment, and bulk calls yourself across dozens of endpoints. Through Jentic you install once, import the Northpass API from the API Directory, store the key once, and your agent calls it.
Permission scoping
Northpass drives its bulk operations from the request body rather than a resource id in the URL path, so scope the agent to the operations it needs, such as listing people or reading assignments. You choose that set, so bulk membership writes or the BambooHR app update are not included unless you add them.
Credential isolation
Your Northpass API key is stored once, encrypted, by your own Jentic One instance and injected as the request header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'enroll a learner in a course' or 'list submissions', and Jentic returns the matching Northpass operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Northpass API through Jentic.
Why is there no official OpenAPI spec for Northpass API?
Northpass does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Northpass 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 Northpass API use?
The Northpass API uses an API key passed in the X-Api-Key header. Through Jentic, the key is held in your Jentic One instance and injected at execution time, so the agent never sees the raw value in its context.
Can I bulk-enroll learners with the Northpass API?
Yes. The /v2/bulk/people/membership endpoint adds many people to groups in a single call, and /v2/bulk/groups/courses bulk-assigns courses to groups. This is the recommended path for enrolling cohorts of hundreds at once.
What are the rate limits for the Northpass API?
The OpenAPI spec does not declare specific rate limits. Northpass enforces limits in production; check the response headers and Northpass developer documentation for current values, and use the bulk endpoints to reduce request volume for large enrollments.
How do I sync BambooHR employees into Northpass through Jentic?
Search Jentic for 'sync bamboohr employees to learning portal'. Jentic returns the PUT /v2/apps/bamboo_hr operation to configure the integration and the bulk membership endpoints for placing employees into the right groups.
Can I issue completion certificates programmatically?
Yes. The credentials and assignment submission endpoints expose certificate data, and you can list assignment submissions via /v2/assignments/{assignment_uuid}/submissions to identify learners eligible for certification before issuing.
Can I limit what my agent is allowed to do with the Northpass API?
Yes. Because you run Jentic One yourself, your own rules decide which Northpass operations and credentials the agent may use, so you can grant only what a task needs, such as listing people or reading assignments and their submissions. This matters for Northpass because its bulk actions are driven by the request body rather than a resource id in the URL path, so write operations like bulk membership changes or the BambooHR app update are not available to the agent unless you explicitly add them. The stored API key is injected at execution time, so the agent can call only the operations you allow.
GET STARTED