canonical: https://jentic.com/apis/northpass.com/northpass # Northpass API 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. ## For AI agents Manage learners, courses, learning paths, assignments, certificates, and groups in a Northpass customer academy. Supports bulk enrollment and HRIS sync. ## Scope Does not handle live video classes, payment processing, or HRIS source-of-truth - use for customer and partner academy delivery only. ## Capabilities - 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 ### 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. Example prompt: 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. Example prompt: 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. Example prompt: 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. Example prompt: Look up a learner's current course progress and outstanding assignments, then summarise next recommended steps ## Key endpoints | 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 | ## Key resources - **Courses** — Create courses, list catalog content, and manage course metadata - **Learning Paths** — Group ordered courses into multi-step learning journeys - **People** — Manage learner profiles, enrollments, and activity history - **Groups** — Segment learners and scope course access by group membership - **Certificates** — Issue and retrieve completion certificates - **Assignments** — Manage assignments and review submissions for grading - **Bulk Actions** — Bulk-create groups, enrol cohorts, and assign courses at scale - **Apps** — Configure HRIS integrations such as BambooHR ## Why Jentic - **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 handling:** 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. - **Discovery method:** 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 - **TalentLMS API** — TalentLMS is another cloud LMS focused on internal training rather than branded customer academies. - **Wild Apricot API** — Wild Apricot manages member organisations; pair with Northpass to deliver education programmes to members. - **HubSpot Contacts API** — Sync customer records from HubSpot into Northpass to drive academy enrollment from CRM lifecycle stages. ## FAQ ### 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.