Skip to main content
GET
/
course_lesson_interactions
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const courseLessonInteraction = await client.courseLessonInteractions.retrieve(
  'crsli_xxxxxxxxxxxx',
);

console.log(courseLessonInteraction.id);
{
  "id": "crsli_xxxxxxxxxxxx",
  "completed": true,
  "created_at": "2023-12-01T05:00:00.401Z",
  "lesson": {
    "id": "lesn_xxxxxxxxxxxxx",
    "title": "Understanding Candlestick Patterns",
    "chapter": {
      "id": "chap_xxxxxxxxxxxxx"
    }
  },
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "course": {
    "id": "cors_xxxxxxxxxxxxx",
    "title": "Introduction to Technical Analysis",
    "experience": {
      "id": "exp_xxxxxxxxxxxxxx"
    }
  }
}

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The unique identifier of the lesson interaction to retrieve.

Example:

"crsli_xxxxxxxxxxxx"

Response

A successful response

A record of a user's progress on a specific lesson, tracking whether they have completed it.

id
string
required

The unique identifier for the lesson interaction.

Example:

"crsli_xxxxxxxxxxxx"

completed
boolean
required

Whether the user has finished this lesson.

created_at
string<date-time>
required

The datetime the lesson interaction was created.

Example:

"2023-12-01T05:00:00.401Z"

lesson
object
required

The lesson that this progress record belongs to.

user
object
required

The user whose progress is being tracked.

course
object
required

The course that contains the tracked lesson.