Developers
Lessons16

List lessons

GET/products/{product_id}/lessons

Returns the lessons of a product, using cursor pagination. Lesson bodies are not included; use the content endpoint to retrieve them.

The collection can be filtered by module, status, format, and name. Set unassigned to true to return only lessons that are not in a module. Trashed lessons are excluded by default; set deleted to true to return only lessons in the trash.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
module_id?string

Only lessons in the module with this public ID.

unassigned?boolean

When true, returns only lessons that are not in a module.

status?string

Only lessons with this status.

Value in

  • "published"
  • "draft"
format?string

Only lessons in this format.

Value in

  • "standard"
  • "quiz"
  • "live_youtube"
  • "live_vimeo"
q?string

Text search term.

deleted?boolean

When true, returns only items in the trash. Items in the trash are excluded by default.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/lessons"
{  "data": [    {      "connection": {        "connected": true,        "source_lesson_id": "string",        "source_product_id": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "deleted": true,      "exam_id": "string",      "format": "standard",      "id": "string",      "image": "string",      "module_id": "string",      "name": "string",      "object": "lesson",      "pinned": true,      "position": 0,      "product_id": "string",      "published_at": "2019-08-24T14:15:22Z",      "revision": "string",      "settings": {},      "status": "published",      "summary": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Lessons16

Lessons in API v3: list lessons, create a lesson, retrieve a lesson, update a lesson, delete a lesson, list lesson attachments, add or update an attachment, remove an attachment, retrieve a lesson connection, connect a lesson, disconnect a lesson, retrieve lesson content, replace lesson content, duplicate a lesson, list lesson taxonomy terms, replace lesson taxonomy terms.

Create a lesson POST

Creates a lesson in the product, optionally inside a module. New lessons are created as drafts. `position` is 1-based among the lesson's siblings; a value greater than the number of siblings places the lesson at the end. The `Location` header of the response contains the URL of the new lesson. Lessons cannot be created in replicated products; such requests return `replica_readonly`.