Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iSpring Learn enrollment API

Enrollment operations

iSpring Learn enrollment API is one of 20 APIs that iSpring Learn publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include enrollment. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 3.0.

Requests are made against a single base URL, https://api-learn.ispring.com.

8 operations 5 paths 12 schemas 3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0
Base URL
https://api-learn.ispringlearn.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iSpring Learn enrollment API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

enrollment 8

Enrollment operations

GET
/enrollment
Get enrollment list
GetEnrollments 3 params → 200
POST
/enrollment
Create new enrollments
EnrollLearnersInCourses body → 201400401403
GET
/enrollments
List enrollments
ListEnrollments 5 params → 200400401403
POST
/enrollments
List enrollments
ListEnrollmentsByPost body → 200400401403
GET
/enrollment/{enrollmentId}
Get enrollment details
GetEnrollment 1 param → 200400401403
POST
/enrollment/{enrollmentId}
Update enrollment
ChangeEnrollment 1 param body → 200400401403
POST
/enrollment/{enrollmentId}/reenroll
Reenroll learner
Reenroll 1 param body → 200400401403
POST
/enrollment/delete
Delete enrollments
Unenroll body → 204400401403

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Enrollment (9 properties), NewEnrollment (7 properties), Reenroll (5 properties), UpdateEnrollment (5 properties). Each schema is shown below with its type and property counts.

NewEnrollment
object
7 properties 3 required
ErrorResponse
object
2 properties 2 required
DueDateType
string
ArrayOfIds
array
UpdateEnrollment
object
5 properties 2 required
Enrollment
object
9 properties 6 required
ListEnrollmentsRequest
object
5 properties
EnrollmentsPage
object
2 properties 1 required
EnrollmentTypeGroup
integer
0 - Enrolled by admin 1 - Enrolled from catalog
DeleteEnrollments
object
1 property 1 required
Reenroll
object
5 properties 2 required
IssuedCertificateInformation
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ispring-enrollment-api-openapi.yml Raw ↑

Other APIs iSpring Learn publishes across the network.

iSpring Learn assignments API
iSpring Learn certificate API
iSpring Learn content API
iSpring Learn department API
iSpring Learn departments API
iSpring Learn gamification API
iSpring Learn group API
iSpring Learn jobtraining API
iSpring Learn learning_track API
iSpring Learn performance-management API
iSpring Learn quizzes API
iSpring Learn report API