ClickFunnels Courses::Lesson Completion API

openapi: 3.2.0
info:
  title: ClickFunnels Courses::Lesson Completion API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Courses::LessonCompletion
  description: '> Marks a lesson as completed for enrollment.


    To mark a lesson as completed by an enrollment, create an `Courses::LessonCompletion` record.

    To undo this, the `Courses::LessonCompletion` record must be deleted.

    '
paths:
  /courses/{course_id}/lesson_completions:
    get:
      tags:
      - Courses::LessonCompletion
      summary: List Lesson Completions
      description: List of enrollment-completion records showing which lessons have been completed by which enrollments. You can filter on one or more `enrollment_id` or `lesson_id` records (see filter params).
      operationId: listCoursesLessonCompletions
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      - name: filter
        in: query
        description: 'Filter by available properties in query params, like this: `api/v2/resources?filter[id]=value&filter[another_property]=value1,value2`. Check our Filtering guide for examples and all about filtering [here](https://developers.myclickfunnels.com/docs/filtering).

          '
        required: false
        schema:
          type: object
          properties:
            enrollment_id:
              type: string
              description: A comma-separated list of enrollement IDs to filter by.
              example: 1,42
            lesson_id:
              type: string
              description: A comma-separated list of lesson IDs to filter by.
              example: 1,2,3
        style: deepObject
        explode: true
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CoursesLessonCompletionAttributes'
              example:
              - id: 2
                public_id: NZDTsU
                enrollment_id: 12
                lesson_id: 12
                completed_at: '2025-01-01T00:00:00.000Z'
              - id: 3
                public_id: AwMUmq
                enrollment_id: 13
                lesson_id: 13
                completed_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
    post:
      tags:
      - Courses::LessonCompletion
      summary: Create Lesson Completion
      description: Mark a lesson as completed by a specific enrollment. You can only mark a lesson as completed once. Subsequent completions for the same lesson by the same enrollment will return a conflict error.
      operationId: createCoursesLessonCompletions
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Lesson Completion
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                courses_lesson_completion:
                  type: object
                  $ref: '#/components/schemas/CoursesLessonCompletionParameters'
            example:
              courses_lesson_completion:
                enrollment_id: 2
                lesson_id: 2
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesLessonCompletionAttributes'
              example:
                id: 5
                public_id: VbFKls
                enrollment_id: 15
                lesson_id: 15
                completed_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
  /courses/lesson_completions/{id}:
    get:
      tags:
      - Courses::LessonCompletion
      summary: Fetch Lesson Completion
      description: Retrieve a enrollment-lesson completion record
      operationId: getCoursesLessonCompletions
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesLessonCompletionAttributes'
              example:
                id: 4
                public_id: pGoNfq
                enrollment_id: 14
                lesson_id: 14
                completed_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    delete:
      tags:
      - Courses::LessonCompletion
      summary: Remove Lesson Completion
      description: Unmark a lesson as completed. This action deletes the record.
      operationId: removeCoursesLessonCompletions
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      name: sort_property
      in: query
      description: '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.

        '
      required: false
      schema:
        type: string
        enum:
        - id
        - updated_at
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  schemas:
    CoursesLessonCompletionAttributes:
      type: object
      title: Completed lessons
      description: Completed lessons
      properties:
        id:
          type: integer
          description: ID
        public_id:
          type:
          - string
          - 'null'
          description: Public ID
        enrollment_id:
          type: integer
          description: The ID of the `Courses::Enrollment` record that completed the lesson
        lesson_id:
          type: integer
          description: The ID of the `Courses::Lesson` record that was completed
        completed_at:
          type: string
          format: date-time
          description: The time when the record was completed; It is set automatically to the current time when the record is created
      example:
        id: 1
        public_id: MkFHBo
        enrollment_id: 2
        lesson_id: 2
        completed_at: '2025-01-01T00:00:00.000Z'
      required:
      - completed_at
      - enrollment_id
      - id
      - lesson_id
      - public_id
    CoursesLessonCompletionParameters:
      type: object
      title: Completed lessons
      description: Completed lessons
      required:
      - enrollment_id
      - lesson_id
      properties:
        enrollment_id:
          type: integer
          description: The ID of the `Courses::Enrollment` record that completed the lesson
        lesson_id:
          type: integer
          description: The ID of the `Courses::Lesson` record that was completed
      example:
        courses_lesson_completion:
          enrollment_id: 2
          lesson_id: 2
  headers:
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com