Skip to main content

CourseById

Returns metadata and the outline of the course. For more documentaiton on fetching content, see the fetching content documentation here [https://developer.thoughtindustries.com/docs/guides/fetching-content-with-graphql]. The results of this query can be affected by providing an authToken header to set a user for the operation.

CourseById(
  id: ID!
): Course!

Directives​

authAccess​

This requires the current user to be in STUDENT role.

Arguments​

CourseById.id ● ID! non-null scalar​

The ID of the course. This can fetched from CatalogContent > displayCourse.

Type​

Course object​

Examples​

Run in Postman

Query:​

CourseById($id: ID!) {
 CourseById(id: $id) {
   id
   createdAt
   updatedAt
   slug
   status
   title
   sessionIsTitled
   sampleLesson {
     ...LessonFragment
   }
   sampleLessonId
   sections {
     ...SectionFragment
   }
   appearanceBlock
   appearanceHash
   paywallsBlock
   termsBlock
   confirmationBlock
   courseStartDate
   courseEndDate
   enrollmentStartDate
   enrollmentEndDate
   gracePeriodEndDate
   seatsLimit
   waitlistCount
   seatsLimitMet
   waitlistingEnabled
   waitlistingTriggered
   taxable
   purchasable
   taxCategory
   fulfillmentCenter
   courseGroup {
     ...CourseGroupFragment
   }
   syllabusTitlesEnabled
   galleryEnabled
   workbookEnabled
   linkedWorkbookEnabled
   linkedWorkbookSkipEnabled
   superquizEnabled
   discussionsEnabled
   resourcesEnabled
   meetingsOverviewEnabled
   instructorAccessEnabled
   instructorEmails
   freeWithRegistration
   priceInCents
   instructorAccessPriceInCents
   suggestedRetailPriceInCents
   alternativePricingType
   alternativePricingRef
   accessDays
   showProgress
   forceLinearProgress
   completionTimePerPage
   askLearnerPassword
   roster
   topicGroupId
   sku
   prerequisiteCourses {
     ...CourseFragment
   }
   prerequisiteLearningPaths {
     ...LearningPathFragment
   }
   parentCourseId
   isChild
   hasMultipleCurrencies
   prices {
     ...ItemPriceFragment
   }
   enrollmentActive
   waitlistActive
   webinarDates {
     ...DateRangeFragment
   }
   webinarTimeZone
   meetings {
     ...MeetingFragment
   }
   inPersonEventInfo {
     ...InPersonEventInfoFragment
   }
   currentUserHasAccess
   location {
     ...LocationFragment
   }
   displayMap
   publishDate
   isActive
   futurePublishDate
   balanceRequirement
   awardClaimingOptions {
     ...CourseAwardClaimingOptionFragment
   }
   availabilityStatus
   embeddedEnabled
   displayResults
   bulkPurchasingEnabled
   seatTiers {
     ...SeatTierFragment
   }
   seatPackages {
     ...SeatPackageFragment
   }
   lastTierPriceInCents
   webinarId
   hasChildren
   customFields
   kind
   rosterSubmittedDate
   finalAssessment
   scormCollectUserDetails
   seatsUsedCount
   seatsAllocatedCount
   webinarDetails {
     ...WebinarBlockFragment
   }
   showSyllabusWhileUnenrolled
   topicGroup {
     ...TopicGroupFragment
   }
   courseGroupTitle
 }
}

Variables:​

{
 "id": "58ccb96c-8e90-4464-86e0-f284442981df"
}

Response:​

{
  "data": {
    "CourseById": {
      "id": "58ccb96c-8e90-4464-86e0-f284442981df",
      "createdAt": "2023-12-20T16:58:58.782Z",
      "updatedAt": "2024-06-20T16:58:58.782Z",
      "slug": "Slug",
      "status": "draft",
      "title": "xyz789",
      "sessionIsTitled": true,
      "sampleLesson": "Lesson",
      "sampleLessonId": "58ccb96c-8e90-4464-86e0-f284442981df",
      "sections": [
        "Section"
      ],
      "appearanceBlock": "58ccb96c-8e90-4464-86e0-f284442981df",
      "appearanceHash": "xyz789",
      "paywallsBlock": "58ccb96c-8e90-4464-86e0-f284442981df",
      "termsBlock": "58ccb96c-8e90-4464-86e0-f284442981df",
      "confirmationBlock": "58ccb96c-8e90-4464-86e0-f284442981df",
      "courseStartDate": "2024-06-20T16:58:58.782Z",
      "courseEndDate": "2024-06-20T16:58:58.782Z",
      "enrollmentStartDate": "2023-12-20T16:58:58.782Z",
      "enrollmentEndDate": "2024-06-20T16:58:58.782Z",
      "gracePeriodEndDate": "2024-06-20T16:58:58.782Z",
      "seatsLimit": 678,
      "waitlistCount": 678,
      "seatsLimitMet": true,
      "waitlistingEnabled": true,
      "waitlistingTriggered": false,
      "taxable": false,
      "purchasable": false,
      "taxCategory": "58ccb96c-8e90-4464-86e0-f284442981df",
      "fulfillmentCenter": "58ccb96c-8e90-4464-86e0-f284442981df",
      "courseGroup": "courseGroup-1",
      "syllabusTitlesEnabled": true,
      "galleryEnabled": false,
      "workbookEnabled": false,
      "linkedWorkbookEnabled": false,
      "linkedWorkbookSkipEnabled": true,
      "superquizEnabled": false,
      "discussionsEnabled": false,
      "resourcesEnabled": false,
      "meetingsOverviewEnabled": false,
      "instructorAccessEnabled": true,
      "instructorEmails": [
        "xyz789"
      ],
      "freeWithRegistration": false,
      "priceInCents": 678,
      "instructorAccessPriceInCents": 678,
      "suggestedRetailPriceInCents": 678,
      "alternativePricingType": "membership",
      "alternativePricingRef": 678,
      "accessDays": 678,
      "showProgress": true,
      "forceLinearProgress": true,
      "completionTimePerPage": 678,
      "askLearnerPassword": false,
      "roster": false,
      "topicGroupId": "58ccb96c-8e90-4464-86e0-f284442981df",
      "sku": "xyz789",
      "prerequisiteCourses": [
        "Course"
      ],
      "prerequisiteLearningPaths": [
        "LearningPath"
      ],
      "parentCourseId": "58ccb96c-8e90-4464-86e0-f284442981df",
      "isChild": false,
      "hasMultipleCurrencies": true,
      "prices": [
        "ItemPrice"
      ],
      "enrollmentActive": true,
      "waitlistActive": true,
      "webinarDates": [
        "DateRange"
      ],
      "webinarTimeZone": "abc123",
      "meetings": [
        "Meeting"
      ],
      "inPersonEventInfo": "InPersonEventInfo",
      "currentUserHasAccess": false,
      "location": "Location",
      "displayMap": true,
      "publishDate": "2023-12-20T16:58:58.782Z",
      "isActive": true,
      "futurePublishDate": "2024-06-20T16:58:58.782Z",
      "balanceRequirement": 236.56,
      "awardClaimingOptions": [
        "CourseAwardClaimingOption"
      ],
      "availabilityStatus": "abc123",
      "embeddedEnabled": true,
      "displayResults": true,
      "bulkPurchasingEnabled": false,
      "seatTiers": [
        "SeatTier"
      ],
      "seatPackages": [
        "SeatPackage"
      ],
      "lastTierPriceInCents": 678,
      "webinarId": "xyz789",
      "hasChildren": true,
      "customFields": "{}",
      "kind": "microCourse",
      "rosterSubmittedDate": "2024-06-20T16:58:58.782Z",
      "finalAssessment": "abc123",
      "scormCollectUserDetails": true,
      "seatsUsedCount": 678,
      "seatsAllocatedCount": 678,
      "webinarDetails": "WebinarBlock",
      "showSyllabusWhileUnenrolled": true,
      "topicGroup": "TopicGroup",
      "courseGroupTitle": "xyz789"
    }
  }
}