Skip to main content

Course

For loop type lifter_course, here are the query parameters and fields.

Query parameters​

  • access_plan - Access Plan ID(s) assigned to a course.
    Type: string, array

  • certificate_earned - User completed the course
    Type: boolean

  • completed - User completed the course
    Type: boolean

  • enrolled - Current user is enrolled
    Type: boolean

  • has_prerequisite - Course has prerequisite, "true"/"false"
    Type: boolean

  • has_quizzes - Course has quiz(zes), "true"/"false"
    Type: boolean

  • instructor - Instructor ID(s) or "current" assigned to a course.
    Type: string, array

  • is_purchasable - Course is purcasable(at least one access plan + at least one gateway enabled), "true"/"false"
    Type: boolean

  • student - Student ID(s) or "current" enrolled in a course.
    Type: string, array

Fields​

  • access_plans - Course access plans

  • audio - Course audio embed

  • available_points - Course available points

  • average_grade - Calculated value of the overall average grade of all *enrolled* students in the course.

  • average_progress - Calculated value of the overall average progress of all *enrolled* students in the course.

  • capacity - Number of students who can be enrolled in the course

  • capacity_message - Message displayed when capacity has been reached

  • categories - Course categories

  • closed_message - Message displayed to visitors when the course is accessed after the Course End Date has passed.

  • content - Course content

  • content_restricted_message - Message displayed when non-enrolled visitors try to access lessons/quizzes directly

  • difficulty - Course difficulty

  • end_date - Date when a course closes. Students may no longer view content or complete lessons / quizzes after this date.

  • enrolled_students - Course enrolled students

  • enrollment_closed_message - Message displayed to non-enrolled visitors when the course is accessed after the Enrollment End Date has passed.

  • enrollment_end_date - After this date, registration closes

  • enrollment_opens_message - Message displayed to non-enrolled visitors when the course is accessed before the Enrollment Start Date has passed.

  • enrollment_period - Whether or not a course time period restriction is enabled, "true"/"false"

  • enrollment_start_date - Before this date, registration is closed

  • has_capacity - Course has capacity , "true"/"false"

  • has_prerequisite - Course has prerequisite, "true"/"false"

  • id - Course ID

  • instructors - Course instructors, instructors_assistants

  • is_prerequisite_complete - Course prerequisite completed, "true"/"false"

  • is_purchasable - Course is purcasable(at least one access plan + at least one gateway enabled), "true"/"false"

  • length - Course length string - defined in admin

  • length_seconds - Course length in seconds

  • lessons - Course lessons

  • opens_message - Message displayed to visitors when the course is accessed before the Course Start Date has passed.

  • prerequisite - Prerequisite course

  • quizzes - Course quizzes

  • sales_page_content_page_id - ID of the WP page to redirect to when $sales_page_content_type is 'page'

  • sales_page_content_type - Sales page behavior [none,content,page,url]

  • sales_page_content_url - Redirect URL for a sales page, when $sales_page_content_type is 'url'

  • sections - Course sections

  • start_date - Date when a course opens. Students may register before this date but can only view content and complete lessons or quizzes after this date.

  • student_certificate_earned - Course specific student earned certificate

  • student_completed_course - Course specific student completed course, "true"/"false"

  • student_completion_date - Course specific student completion date

  • student_course_progres - Course specific student progress

  • student_enrolled - Course specific(current) student student enrolled

  • student_enrollment_date - Course specific student enrollment date

  • student_grade - Course specific student grade

  • student_last_completed_lesson - Course specific student last completed lesson

  • student_next_lesson - Course specific student next lesson

  • time_period_enabled - Course time period enabled, "true"/"false"

  • user_has_access - If User has access to the course, string "true"/"false"

  • video - Course video embed