Skip to content

Course

A Course

Fields

active · Boolean! · required · Whether the course is active
clients · [CourseMembership!] · Course clients
clients_groups · [CourseGroup!] · Course group memberships for the course
completed_course_memberships_count · Int · The number of completed memberships in the course
course_benefits · [CourseBenefit!]! · required · The benefits of a course
course_groups · [CourseGroup!] · Course group memberships for the course
course_items · [CourseItem!]! · required · The items of a course
course_memberships · [CourseMembership!] · Course memberships for the course
course_memberships_count · String · The number of members in the course
course_type · String! · required · type of the course
created_at · String! · required · date course was created
cursor · Cursor! · required · Pagination cursor
deleted_at · String · date course was deleted
description · String · Description of course
end_date · String · end date of the course based on included items
formatted_benefits · String · HTML-formatted benefits of the course
id · ID! · required · The unique identifier of the course
in_progress_course_memberships_count · Int · The number of in progress memberships in the course
late_enroll · Boolean · late enrollment for fixed type courses
name · String · Name of course
not_started_course_memberships_count · Int · The number of not started memberships in the course
offerings · [Offering!] · Offerings contains current course
preview_image_url · String · url for course image
preview_video_content · String · url for course video
start_date · String · start date for fixed type course
ungrouped_course_memberships · [CourseMembership!] · Ungrouped Course memberships for the course
updated_at · String · date course was updated
use_category · Boolean · Use category toggle
use_video_label · Boolean · Use video label toggle
user_groups · [UserGroup!]! · required · The user groups who have access to this course
user_id · ID · User id of course
users · [User!]! · required · The users who have access to this course
users_course_items_progress · String · The progress of users who completed the course item
users_progress · String · The users course progress

Used By

Definition

"""
A Course
"""
type Course {
"""
Whether the course is active
"""
active: Boolean!
"""
Course clients
"""
clients(
"""
Filter by course status
"""
course_status: String
): [CourseMembership!]
"""
Course group memberships for the course
"""
clients_groups(
"""
Filter by course status
"""
course_status: String
): [CourseGroup!]
"""
The number of completed memberships in the course
"""
completed_course_memberships_count: Int
"""
The benefits of a course
"""
course_benefits: [CourseBenefit!]!
"""
Course group memberships for the course
"""
course_groups: [CourseGroup!]
"""
The items of a course
"""
course_items(
"""
Include custom emails
"""
include_emails: Boolean = true
): [CourseItem!]!
"""
Course memberships for the course
"""
course_memberships: [CourseMembership!]
"""
The number of members in the course
"""
course_memberships_count: String
"""
type of the course
"""
course_type: String!
"""
date course was created
"""
created_at: String!
"""
Pagination cursor
"""
cursor: Cursor!
"""
date course was deleted
"""
deleted_at: String
"""
Description of course
"""
description: String
"""
end date of the course based on included items
"""
end_date: String
"""
HTML-formatted benefits of the course
"""
formatted_benefits: String
"""
The unique identifier of the course
"""
id: ID!
"""
The number of in progress memberships in the course
"""
in_progress_course_memberships_count: Int
"""
late enrollment for fixed type courses
"""
late_enroll: Boolean
"""
Name of course
"""
name: String
"""
The number of not started memberships in the course
"""
not_started_course_memberships_count: Int
"""
Offerings contains current course
"""
offerings: [Offering!]
"""
url for course image
"""
preview_image_url: String
"""
url for course video
"""
preview_video_content: String
"""
start date for fixed type course
"""
start_date: String
"""
Ungrouped Course memberships for the course
"""
ungrouped_course_memberships: [CourseMembership!]
"""
date course was updated
"""
updated_at: String
"""
Use category toggle
"""
use_category: Boolean
"""
Use video label toggle
"""
use_video_label: Boolean
"""
The user groups who have access to this course
"""
user_groups: [UserGroup!]!
"""
User id of course
"""
user_id: ID
"""
The users who have access to this course
"""
users: [User!]!
"""
The progress of users who completed the course item
"""
users_course_items_progress: String
"""
The users course progress
"""
users_progress: String
}