MYmyclickfunnels
Courses::Lesson

List Lessons

Changed on

List Lessons. Ordered by id ascending by default (pass sort_order=desc for descending), consistent with the pagination cursor, so following the Pagination-Next header returns every lesson exactly once.

Pass sort_property=sort_order for the builder's display order of lessons within the section (sort_order is scoped per section, starting at 0).

get/courses/sections/{section_id}/lessons

Request

Path parameters

section_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at' | 'sort_order'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

ID

public_idstring nullable

Public ID

titlestring

Title

bodystring nullable

Description

section_idinteger nullable

Parent module

published_atstring date-time nullable

Schedule for

current_pathstring nullable

Current Path

sort_orderinteger nullable

Builder display order of the lesson within its section (section_id). Scoped per section, starting at 0.

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 1,
    "public_id": "ucGpIe",
    "title": "Lesson 1",
    "body": "Example Lesson",
    "section_id": 2,
    "published_at": "2025-01-01T00:00:00.000Z",
    "current_path": null,
    "sort_order": 0,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "image": {
      "id": 456,
      "public_id": "XyZaBcDe",
      "name": "Welcome cover",
      "url": "https://images.clickfunnels.com/ab/cd/welcome-cover.png"
    },
    "video": {
      "id": 789,
      "public_id": "AbCdEfGh",
      "name": "Module 1: Welcome",
      "url": "https://media.example.com/video/789/original.mp4?token=abc&expires=1792522800"
    }
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter section_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status