Skilljar Lesson Progress API
The Lesson Progress API from Skilljar — 1 operation(s) for lesson progress.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/skilljar-lesson-progress-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Skilljar Assets Lesson Progress API
version: 1.0.0
description: 'The Skilljar API provides comprehensive access to our customer education platform, enabling you to programmatically manage courses, users, enrollments, and more.
This interactive documentation is automatically generated from our codebase and stays current with the latest features and endpoints.
## Getting Started
New to the Skilljar API? Check out these essential resources:
- **[API Getting Started Guide](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Getting_started_with_the_Skilljar_API)** - Authentication, basic concepts, and your first API call
- **[Token-based SSO](https://support.gainsight.com/Skilljar/Develop_and_Customize/Single_Sign_on_(SSO)/Configuring_Token-Based_Single_Sign-On_(SSO))** - Seamlessly integrate user authentication
- **[Webhooks](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Using_Webhooks_API)** - Real-time notifications for platform events
'
servers:
- url: https://api.skilljar.com/v1/
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Lesson Progress
paths:
/v1/lesson-progress/{lesson_progress_id}:
get:
operationId: lesson_progress_retrieve
description: "Retrieve the progress details for a specific lesson progress object.\n\nReturns the current completion status, timestamps, and other progress information for\n the student's lesson attempt."
parameters:
- in: path
name: lesson_progress_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Lesson Progress
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgress'
description: ''
put:
operationId: lesson_progress_update
description: 'Update the progress for a specific lesson progress object.
Setting `finished_at` indicates the student as finished the content. This will
also This will also mark the lesson complete unless the lesson requires validation,
such as a review of proctoring. To un-complete the lesson, set `completed_at` to null.
Both PUT and PATCH requests perform partial updates.'
parameters:
- in: path
name: lesson_progress_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Lesson Progress
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgressRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LessonProgressRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LessonProgressRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgress'
description: ''
patch:
operationId: lesson_progress_partial_update
description: 'Partially update the progress for a specific lesson progress object.
Setting `finished_at` indicates the student as finished the content. This will
also This will also mark the lesson complete unless the lesson requires validation,
such as a review of proctoring. To un-complete the lesson, set `completed_at` to null.
Both PUT and PATCH requests perform partial updates.'
parameters:
- in: path
name: lesson_progress_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Lesson Progress
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLessonProgressRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLessonProgressRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLessonProgressRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgress'
description: ''
components:
schemas:
PatchedLessonProgressRequest:
type: object
properties:
finished_at:
type:
- string
- 'null'
format: date-time
description: ISO 8601 formatted datetime string indicating when the user finished the lesson content. Setting this field will also mark the lesson complete unless the lesson requires validation, such as a review of proctoring.
completed_at:
type:
- string
- 'null'
format: date-time
description: ISO 8601 formatted datetime string indicating when the user completed the lesson. If null, the user has not completed the lesson.
success_status:
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/SuccessStatusEnum'
- $ref: '#/components/schemas/NullEnum'
score:
type:
- integer
- 'null'
maximum: 2147483647
minimum: 0
description: Score received
max_score:
type:
- integer
- 'null'
maximum: 2147483647
minimum: 0
description: Max possible score
custom_data:
type:
- string
- 'null'
validation_status:
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/ValidationStatusEnum'
- $ref: '#/components/schemas/NullEnum'
validation_data:
description: JSON formatted. Ignored if the lesson does not require validation.
ValidationStatusEnum:
enum:
- PASSED
- FAILED
type: string
description: '* `PASSED` - Passed
* `FAILED` - Failed'
NullEnum:
enum:
- null
LessonProgress:
type: object
properties:
view_count:
type: integer
readOnly: true
last_viewed_on:
type:
- string
- 'null'
format: date-time
readOnly: true
finished_at:
type:
- string
- 'null'
format: date-time
description: ISO 8601 formatted datetime string indicating when the user finished the lesson content. Setting this field will also mark the lesson complete unless the lesson requires validation, such as a review of proctoring.
completed_at:
type:
- string
- 'null'
format: date-time
description: ISO 8601 formatted datetime string indicating when the user completed the lesson. If null, the user has not completed the lesson.
success_status:
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/SuccessStatusEnum'
- $ref: '#/components/schemas/NullEnum'
score:
type:
- integer
- 'null'
maximum: 2147483647
minimum: 0
description: Score received
max_score:
type:
- integer
- 'null'
maximum: 2147483647
minimum: 0
description: Max possible score
custom_data:
type:
- string
- 'null'
validation_status:
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/ValidationStatusEnum'
- $ref: '#/components/schemas/NullEnum'
validation_data:
description: JSON formatted. Ignored if the lesson does not require validation.
id:
type: string
readOnly: true
description: Known as lesson_progress_id within the documentation
SuccessStatusEnum:
enum:
- PASSED
- FAILED
type: string
description: '* `PASSED` - Passed
* `FAILED` - Failed'
LessonProgressRequest:
type: object
properties:
finished_at:
type:
- string
- 'null'
format: date-time
description: ISO 8601 formatted datetime string indicating when the user finished the lesson content. Setting this field will also mark the lesson complete unless the lesson requires validation, such as a review of proctoring.
completed_at:
type:
- string
- 'null'
format: date-time
description: ISO 8601 formatted datetime string indicating when the user completed the lesson. If null, the user has not completed the lesson.
success_status:
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/SuccessStatusEnum'
- $ref: '#/components/schemas/NullEnum'
score:
type:
- integer
- 'null'
maximum: 2147483647
minimum: 0
description: Score received
max_score:
type:
- integer
- 'null'
maximum: 2147483647
minimum: 0
description: Max possible score
custom_data:
type:
- string
- 'null'
validation_status:
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/ValidationStatusEnum'
- $ref: '#/components/schemas/NullEnum'
validation_data:
description: JSON formatted. Ignored if the lesson does not require validation.
securitySchemes:
OrganizationApiKey:
type: http
scheme: basic
description: API key authentication using HTTP Basic Auth. Use your API key as the username and leave password empty.
tokenAuth:
type: http
scheme: bearer