Sign in
latestOpenAPI 3.1.02026-08-1182263351.1 KB

f8025de20169

Lessons

List lessons

List non-draft lessons for the authenticated organization.

Required OAuth scope: lessons:read

get/v2/lessons/

Query parameters

filter[course_id]string nullable

Obfuscated parent course ID. Exact match.

Obfuscated parent course ID. Exact match.

filter[type]'ASSET' | 'HTML' | 'QUIZ' | 'WEB_PACKAGE' | 'VILT' | 'IE_EXAM' | 'WIDGET' | 'MODULAR' nullable

Lesson type. Exact match. Accepted values: ASSET, HTML, QUIZ, WEB_PACKAGE, VILT, IE_EXAM, WIDGET, MODULAR. Unknown values are rejected with 422.

Lesson type. Exact match. Accepted values: ASSET, HTML, QUIZ, WEB_PACKAGE, VILT, IE_EXAM, WIDGET, MODULAR. Unknown values are rejected with 422.

filter[title]string nullable

Lesson title. Case-insensitive exact match.

Lesson title. Case-insensitive exact match.

filter[updated_since]string date-time nullable

ISO-8601 timestamp with timezone offset (e.g. 2024-01-01T00:00:00Z); returns lessons updated at or after this time. Naive datetimes without an offset are rejected with 422.

ISO-8601 timestamp with timezone offset (e.g. 2024-01-01T00:00:00Z); returns lessons updated at or after this time. Naive datetimes without an offset are rejected with 422.

Response

OK

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

linksobject nullable

Pagination links, e.g. {"self": "...", "next": "...", "prev": null}.

has_moreboolean required

Whether additional pages exist after this one.

next_cursorstring nullable

Opaque cursor to pass as page[cursor] for the next page; null on the last page.

includedobject[] nullable

Related resources requested via ?include=. Absent when no include was requested.