SKskilljar
Lessons

List lessons

Changed on

List non-draft lessons for the authenticated organization.

Required OAuth scope: lessons:read

get/v2/lessons/

Request

Query parameters

page[size]integer

Maximum number of records to return. Values above 100 are served as 100; values below 1 are served as 1.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

filter[course_id]string nullable

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.

filter[title]string nullable

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.

Response

OK

metaobject nullable

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

includedobject[] nullable

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

Changes

  • bed169429eb2Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter page[cursor]

    • info

      added the new optional query request parameter page[size]

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added to the response property anyOf list for the response status

    • info

      removed subschema #1 from the response property anyOf list for the response status

  • 9fc34e55336dRevision changes
    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status