Helium GraphQL API Reference

Documentation related to available types, queries, mutations, etc. in Helium

Contact

Get Support

https://discord.gg/cTJBX4muVn

API Endpoints
https://example.thoughtindustries.com/helium

Queries

BadgeLeaderboard

Response

Returns a BadgeLeaderboard!

Arguments
Name Description
limit - Int

Example

Query
query BadgeLeaderboard($limit: Int) {
  BadgeLeaderboard(limit: $limit) {
    awardType {
      deleted
      icon
      id
      includeOnDashboard
      label
      pluralLabel
    }
    currentUserPosition {
      rank
      total
      user {
        ...UserFragment
      }
    }
    leaders {
      rank
      total
      user {
        ...UserFragment
      }
    }
  }
}
Variables
{"limit": 123}
Response
{
  "data": {
    "BadgeLeaderboard": {
      "awardType": AwardType,
      "currentUserPosition": BadgeLeader,
      "leaders": [BadgeLeader]
    }
  }
}

CatalogContent

Description

Returns catalog content items and meta data matching with the criterias.

Response

Returns a CatalogContent!

Arguments
Name Description
contentTypes - [String!] The list of content types to be queried.
labels - [String!] The list of aggregation labels. The order of list items will match with argument values.
page - Int! The page number to return within the collection.
query - String The search query.
resultsDisplayType - ContentItemDisplayType The display type. Defaults to the value configured for catalog from the user's Thought Industries instance. If the catalog is not configured, it falls back to value grid. When the value is calendar, it overrides the values for argument sortColumn to be displayDate and sortDirection to be asc.
sortColumn - SortColumn The content data column used to sort the collection. Defaults to the value configured for catalog from the user's Thought Industries instance. If the catalog is not configured, it falls back to value createdAt. When the value is relevance, it requires the argument query also to be set, or it falls back to value courseStartDate.
sortDirection - SortDirection The direction used to sort the collection. Defaults to the value configured for catalog from the user's Thought Industries instance. If the catalog is not configured, it falls back to value desc. When the argument sortColumn is relevance, it requires the argument query also to be set, or it falls back to value desc.
token - String The secure catalog query. The value is encoded by the secret key of user's Thought Industries instance.
values - [String!] The list of aggregation values. The order of list items will match with argument labels.

Example

Query
query CatalogContent(
  $contentTypes: [String!],
  $labels: [String!],
  $page: Int!,
  $query: String,
  $resultsDisplayType: ContentItemDisplayType,
  $sortColumn: SortColumn,
  $sortDirection: SortDirection,
  $token: String,
  $values: [String!]
) {
  CatalogContent(
    contentTypes: $contentTypes,
    labels: $labels,
    page: $page,
    query: $query,
    resultsDisplayType: $resultsDisplayType,
    sortColumn: $sortColumn,
    sortDirection: $sortDirection,
    token: $token,
    values: $values
  ) {
    contentItems {
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      expiresAt
      hasChildren
      hideCourseDescription
      id
      isActive
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    meta {
      aggregations {
        ...AggregationFragment
      }
      contentTypeFilterEnabled
      contentTypes
      debug
      displayAuthorsEnabled
      displayBundle {
        ...BundleFragment
      }
      displayDescriptionOnCalendar
      displayStartDateEnabled
      displayTypeCalendarEnabled
      displayTypeGridEnabled
      displayTypeListEnabled
      hasMore
      isCurated
      queryCustomFields
      resultsDisplayType
      selectedSort
      selectedSortColumn
      selectedSortDirection
      sortCourseStartDateEnabled
      sortCreatedAtEnabled
      sortPublishDateEnabled
      sortRelevanceEnabled
      sortTitleEnabled
      sortUpdatedAtEnabled
      tokenLabel
      total
    }
  }
}
Variables
{
  "contentTypes": ["xyz789"],
  "labels": ["xyz789"],
  "page": 987,
  "query": "abc123",
  "resultsDisplayType": "calendar",
  "sortColumn": "courseStartDate",
  "sortDirection": "asc",
  "token": "xyz789",
  "values": ["abc123"]
}
Response
{
  "data": {
    "CatalogContent": {
      "contentItems": [Content],
      "meta": CatalogMeta
    }
  }
}

CatalogQuery

Response

Returns a CatalogContent!

Arguments
Name Description
page - Int The page number to return within the collection.
query - String
queryExclusions - [String!]
queryLimit - Int
querySignature - String
querySort - String

Example

Query
query CatalogQuery(
  $page: Int,
  $query: String,
  $queryExclusions: [String!],
  $queryLimit: Int,
  $querySignature: String,
  $querySort: String
) {
  CatalogQuery(
    page: $page,
    query: $query,
    queryExclusions: $queryExclusions,
    queryLimit: $queryLimit,
    querySignature: $querySignature,
    querySort: $querySort
  ) {
    contentItems {
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      expiresAt
      hasChildren
      hideCourseDescription
      id
      isActive
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    meta {
      aggregations {
        ...AggregationFragment
      }
      contentTypeFilterEnabled
      contentTypes
      debug
      displayAuthorsEnabled
      displayBundle {
        ...BundleFragment
      }
      displayDescriptionOnCalendar
      displayStartDateEnabled
      displayTypeCalendarEnabled
      displayTypeGridEnabled
      displayTypeListEnabled
      hasMore
      isCurated
      queryCustomFields
      resultsDisplayType
      selectedSort
      selectedSortColumn
      selectedSortDirection
      sortCourseStartDateEnabled
      sortCreatedAtEnabled
      sortPublishDateEnabled
      sortRelevanceEnabled
      sortTitleEnabled
      sortUpdatedAtEnabled
      tokenLabel
      total
    }
  }
}
Variables
{
  "page": 123,
  "query": "xyz789",
  "queryExclusions": ["xyz789"],
  "queryLimit": 987,
  "querySignature": "xyz789",
  "querySort": "xyz789"
}
Response
{
  "data": {
    "CatalogQuery": {
      "contentItems": [Content],
      "meta": CatalogMeta
    }
  }
}

CompanyDetails

Response

Returns a CompanyDetails

Arguments
Name Description
user - ID The ID of the User.

Example

Query
query CompanyDetails($user: ID) {
  CompanyDetails(user: $user) {
    name
    settings {
      accentColor
      altFont
      backgroundAsset
      backgroundAssetTiled
      company {
        ...CompanyFragment
      }
      customCss
      font
      globalNavigationLinks {
        ...GlobalNavigationLinkFragment
      }
      id
      linkColor
      logoAsset
      retinaLogo
      secondaryColor
    }
    subdomain
  }
}
Variables
{"user": 4}
Response
{
  "data": {
    "CompanyDetails": {
      "name": "xyz789",
      "settings": AppearanceSettings,
      "subdomain": "abc123"
    }
  }
}

CompanyTranslations

Description

Returns translations from the user's Thought Industries instance.

Response

Returns [TranslationsList!]!

Arguments
Name Description
namespace - TranslationNamespace! The namespace is used to specify the content category for the translations. Accepts values of lms for platform content and emails for email content.

Example

Query
query CompanyTranslations($namespace: TranslationNamespace!) {
  CompanyTranslations(namespace: $namespace) {
    id
    lang
    translations
  }
}
Variables
{"namespace": "emails"}
Response
{
  "data": {
    "CompanyTranslations": [
      {
        "id": "4",
        "lang": "xyz789",
        "translations": {}
      }
    ]
  }
}

CourseById

Response

Returns a Course!

Arguments
Name Description
id - ID!

Example

Query
query CourseById($id: ID!) {
  CourseById(id: $id) {
    accessDays
    alternativePricingRef
    alternativePricingType
    appearanceBlock
    appearanceHash
    askLearnerPassword
    availabilityStatus
    awardClaimingOptions {
      awardAmounts
      awardType {
        ...AwardTypeFragment
      }
      awardTypeId
      range
    }
    balanceRequirement
    bulkPurchasingEnabled
    completionTimePerPage
    confirmationBlock
    courseEndDate
    courseGroup {
      allowRescheduling
      archived
      asset
      authors
      availabilityStatus
      contentType {
        ...ContentTypeFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentUserMayReschedule
      customFields
      description
      detailAsset
      displayBundle {
        ...DisplayBundleFragment
      }
      displayCourse {
        ...CourseFragment
      }
      externalDetailUrl
      externalPurchaseUrl
      hasParentCourseGroup
      id
      isbn
      kind
      language
      layout {
        ...LayoutFragment
      }
      metaDescription
      metaTitle
      ownedByActiveScope
      rating
      relatedCourseGroups {
        ...CourseGroupFragment
      }
      relatedQuery
      relatedQueryLimit
      relatedQuerySignature
      relatedQuerySort
      relatedShowDescription
      relatedShowImageAsset
      ribbon
      slug
      source
      tabs {
        ...CourseTabFragment
      }
      tags {
        ...TagFragment
      }
      title
      videoAsset
    }
    courseStartDate
    createdAt
    currentUserHasAccess
    customFields
    discussionsEnabled
    displayMap
    displayResults
    embeddedEnabled
    enrollmentActive
    enrollmentEndDate
    enrollmentStartDate
    finalAssessment
    forceLinearProgress
    freeWithRegistration
    fulfillmentCenter
    futurePublishDate
    galleryEnabled
    gracePeriodEndDate
    hasChildren
    hasMultipleCurrencies
    id
    inPersonEventInfo {
      heroAsset
      subtitle
    }
    instructorAccessEnabled
    instructorAccessPriceInCents
    instructorEmails
    isActive
    isChild
    kind
    lastTierPriceInCents
    linkedWorkbookEnabled
    linkedWorkbookSkipEnabled
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetings {
      attendeeInfo
      attendees {
        ...UserFragment
      }
      course {
        ...CourseFragment
      }
      courseId
      endDate
      id
      instructors
      location {
        ...LocationFragment
      }
      locationId
      startDate
      timeZone
      title
    }
    meetingsOverviewEnabled
    parentCourseId
    paywallsBlock
    prerequisiteCourses {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    prerequisiteLearningPaths {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    priceInCents
    prices {
      annualPriceInCents
      currencyCode
      id
      instructorAccessPriceInCents
      priceInCents
      suggestedRetailPriceInCents
      variations {
        ...ItemPriceVariationFragment
      }
    }
    publishDate
    purchasable
    resourcesEnabled
    roster
    rosterSubmittedDate
    sampleLesson {
      accessLevel
      id
      section {
        ...SectionFragment
      }
      slug
      slugOrId
      title
    }
    sampleLessonId
    scormCollectUserDetails
    seatPackages {
      seats
    }
    seatTiers {
      priceInCents
      seats
    }
    seatsAllocatedCount
    seatsLimit
    seatsLimitMet
    seatsUsedCount
    sections {
      id
      lessons {
        ...LessonFragment
      }
      slug
      title
    }
    sessionIsTitled
    showProgress
    showSyllabusWhileUnenrolled
    sku
    slug
    status
    suggestedRetailPriceInCents
    superquizEnabled
    syllabusTitlesEnabled
    taxCategory
    taxable
    termsBlock
    title
    topicGroup
    updatedAt
    waitlistActive
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
    webinarDates {
      endDate
      startDate
    }
    webinarDetails {
      attendeeDialIn
      coOrganizers
      enableAutoRecording
      id
      joinUrl
      organizerDialIn
      originalWebinarDates {
        ...WebinarDateFragment
      }
      recurrence
      retrieveRecording
      timeZone
      webexDescription
      webexLabName
      webexNumComputers
      webexReserveHOL
      webexSessionPassword
      webinarDates {
        ...WebinarDateFragment
      }
      webinarProvider
      webinarType
    }
    webinarId
    webinarTimeZone
    workbookEnabled
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "CourseById": {
      "accessDays": 123,
      "alternativePricingRef": 123,
      "alternativePricingType": "membership",
      "appearanceBlock": "4",
      "appearanceHash": "xyz789",
      "askLearnerPassword": true,
      "availabilityStatus": "xyz789",
      "awardClaimingOptions": [CourseAwardClaimingOption],
      "balanceRequirement": 987.65,
      "bulkPurchasingEnabled": true,
      "completionTimePerPage": 987,
      "confirmationBlock": 4,
      "courseEndDate": "2007-12-03",
      "courseGroup": "courseGroup-1",
      "courseStartDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "currentUserHasAccess": false,
      "customFields": {},
      "discussionsEnabled": true,
      "displayMap": true,
      "displayResults": false,
      "embeddedEnabled": false,
      "enrollmentActive": false,
      "enrollmentEndDate": "2007-12-03",
      "enrollmentStartDate": "2007-12-03",
      "finalAssessment": "xyz789",
      "forceLinearProgress": false,
      "freeWithRegistration": false,
      "fulfillmentCenter": 4,
      "futurePublishDate": "2007-12-03",
      "galleryEnabled": false,
      "gracePeriodEndDate": "2007-12-03",
      "hasChildren": false,
      "hasMultipleCurrencies": false,
      "id": "4",
      "inPersonEventInfo": InPersonEventInfo,
      "instructorAccessEnabled": false,
      "instructorAccessPriceInCents": 987,
      "instructorEmails": ["abc123"],
      "isActive": true,
      "isChild": true,
      "kind": "article",
      "lastTierPriceInCents": 987,
      "linkedWorkbookEnabled": true,
      "linkedWorkbookSkipEnabled": true,
      "location": Location,
      "meetings": [Meeting],
      "meetingsOverviewEnabled": false,
      "parentCourseId": "4",
      "paywallsBlock": 4,
      "prerequisiteCourses": [Course],
      "prerequisiteLearningPaths": [LearningPath],
      "priceInCents": 987,
      "prices": [ItemPrice],
      "publishDate": "2007-12-03",
      "purchasable": true,
      "resourcesEnabled": true,
      "roster": true,
      "rosterSubmittedDate": "2007-12-03",
      "sampleLesson": Lesson,
      "sampleLessonId": 4,
      "scormCollectUserDetails": false,
      "seatPackages": [SeatPackage],
      "seatTiers": [SeatTier],
      "seatsAllocatedCount": 987,
      "seatsLimit": 987,
      "seatsLimitMet": true,
      "seatsUsedCount": 987,
      "sections": [Section],
      "sessionIsTitled": true,
      "showProgress": false,
      "showSyllabusWhileUnenrolled": false,
      "sku": "xyz789",
      "slug": Slug,
      "status": "archived",
      "suggestedRetailPriceInCents": 987,
      "superquizEnabled": true,
      "syllabusTitlesEnabled": true,
      "taxCategory": "4",
      "taxable": true,
      "termsBlock": "4",
      "title": "xyz789",
      "topicGroup": 4,
      "updatedAt": "2007-12-03",
      "waitlistActive": true,
      "waitlistCount": 123,
      "waitlistingEnabled": false,
      "waitlistingTriggered": false,
      "webinarDates": [DateRange],
      "webinarDetails": WebinarBlock,
      "webinarId": "xyz789",
      "webinarTimeZone": "abc123",
      "workbookEnabled": true
    }
  }
}

CurrentUser

Response

Returns a User

Example

Query
query CurrentUser {
  CurrentUser {
    abbreviatedName
    accessedFlows
    activeLicense {
      accessDays
      appearance {
        ...AppearanceSettingsFragment
      }
      childLicenses {
        ...LicenseFragment
      }
      client {
        ...ClientFragment
      }
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      dashboardLayoutId
      enableBranding
      expirationDate
      id
      isDefault
      label
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      name
      parentLicense {
        ...LicenseFragment
      }
      parentLicenseId
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      schoolName
      seatsLimit
      sku
      updatedAt
    }
    address1
    address2
    adminClients {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    allocatedLearningPaths {
      learningPath {
        ...LearningPathFragment
      }
      learningPathId
    }
    allocatedLicenses {
      license {
        ...LicenseFragment
      }
      licenseId
      licenseRole
      status
    }
    asset
    attendedMeetings {
      attendanceDate
      meeting {
        ...MeetingFragment
      }
      user {
        ...UserFragment
      }
    }
    availableCoursesCount
    balance
    bio
    certificatesCount
    city
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    clientId
    collaborationsCount
    completedCoursesCount
    country
    createdAt
    customFields
    disabled
    email
    externalCustomerId
    firstName
    id
    invitedByName
    lang
    lastActiveAt
    lastInitial
    lastName
    learnerUserId
    managerUserId
    mustVerifyEmail
    name
    purchasedBundles {
      bundle {
        ...BundleFragment
      }
      bundleId
    }
    purchasedCourses {
      certificate
      certificateIssuedAt
      course {
        ...CourseFragment
      }
      courseId
      instructorAccessPurchased
      status
    }
    recommendedSlugs {
      boost
      slug
    }
    recommendedTags {
      boost
      label
    }
    ref1
    ref2
    ref3
    ref4
    ref5
    ref6
    ref7
    ref8
    ref9
    ref10
    roleKey
    sfAccountId
    sfContactId
    shippingName
    shouldHighlight
    startedCoursesCount
    state
    stripeCustomerId
    telephone
    twoFactorEnabled
    updatedAt
    waitlistedCourses {
      course {
        ...CourseFragment
      }
      courseId
    }
    zipCode
  }
}
Response
{
  "data": {
    "CurrentUser": {
      "abbreviatedName": "xyz789",
      "accessedFlows": ["xyz789"],
      "activeLicense": License,
      "address1": "xyz789",
      "address2": "xyz789",
      "adminClients": [Client],
      "allocatedLearningPaths": [AllocatedLearningPath],
      "allocatedLicenses": [AllocatedLicense],
      "asset": "xyz789",
      "attendedMeetings": [UserAttendedMeeting],
      "availableCoursesCount": 987,
      "balance": 987.65,
      "bio": "xyz789",
      "certificatesCount": 123,
      "city": "xyz789",
      "client": "client-1",
      "clientId": "client-1",
      "collaborationsCount": 987,
      "completedCoursesCount": 123,
      "country": "abc123",
      "createdAt": "2007-12-03",
      "customFields": {},
      "disabled": true,
      "email": "xyz789",
      "externalCustomerId": 4,
      "firstName": "xyz789",
      "id": 4,
      "invitedByName": "xyz789",
      "lang": "xyz789",
      "lastActiveAt": "2007-12-03",
      "lastInitial": "abc123",
      "lastName": "xyz789",
      "learnerUserId": "4",
      "managerUserId": "4",
      "mustVerifyEmail": false,
      "name": "abc123",
      "purchasedBundles": [PurchasedBundle],
      "purchasedCourses": [PurchasedCourse],
      "recommendedSlugs": [UserRecommendedSlug],
      "recommendedTags": [UserRecommendedTag],
      "ref1": "abc123",
      "ref2": "abc123",
      "ref3": "xyz789",
      "ref4": "abc123",
      "ref5": "abc123",
      "ref6": "xyz789",
      "ref7": "abc123",
      "ref8": "abc123",
      "ref9": "abc123",
      "ref10": "xyz789",
      "roleKey": "xyz789",
      "sfAccountId": 4,
      "sfContactId": 4,
      "shippingName": "abc123",
      "shouldHighlight": true,
      "startedCoursesCount": 987,
      "state": "xyz789",
      "stripeCustomerId": 4,
      "telephone": "xyz789",
      "twoFactorEnabled": true,
      "updatedAt": "2007-12-03",
      "waitlistedCourses": [WaitlistedCourse],
      "zipCode": "abc123"
    }
  }
}

Languages

Description

Returns array of Language objects configured in the Thought Industries instance

Response

Returns [Language!]!

Example

Query
query Languages {
  Languages {
    code
    id
    isCustom
    label
    selectorLabel
  }
}
Response
{
  "data": {
    "Languages": [
      {
        "code": "pt",
        "id": "builtin-pt",
        "isCustom": "false",
        "label": "Portuguese",
        "selectorLabel": "Português (Brasil)"
      }
    ]
  }
}

LoadAssessmentAttemptWithQuestions

Description

Returns an existing or new assessment attempt with questions. This is used when user starts a new assessment attempt, or resumes from an in-progress assessment attempt.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
assessmentAttemptId - ID The ID of the in-progress assessment attempt to resume from.
courseId - ID The ID of the Course.
id - ID! The ID of the Topic.
instructorAssessmentUser - ID The ID of the user on behalf of whom the instructor takes the assessment.
linkedWorkbook - ID The ID of the linked workbook.
shouldShuffleAndSubset - Boolean Flag to randomly order questions and choose a subset of questions to use.
topicType - String! The type of the Topic.

Example

Query
query LoadAssessmentAttemptWithQuestions(
  $assessmentAttemptId: ID,
  $courseId: ID,
  $id: ID!,
  $instructorAssessmentUser: ID,
  $linkedWorkbook: ID,
  $shouldShuffleAndSubset: Boolean,
  $topicType: String!
) {
  LoadAssessmentAttemptWithQuestions(
    assessmentAttemptId: $assessmentAttemptId,
    courseId: $courseId,
    id: $id,
    instructorAssessmentUser: $instructorAssessmentUser,
    linkedWorkbook: $linkedWorkbook,
    shouldShuffleAndSubset: $shouldShuffleAndSubset,
    topicType: $topicType
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "assessmentAttemptId": "4",
  "courseId": 4,
  "id": "4",
  "instructorAssessmentUser": "4",
  "linkedWorkbook": 4,
  "shouldShuffleAndSubset": true,
  "topicType": "abc123"
}
Response
{
  "data": {
    "LoadAssessmentAttemptWithQuestions": {
      "adminUpdatedGrade": true,
      "answeredQuestionsCount": 987,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": "4",
      "correctQuestionsCount": 123,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": false,
      "grade": 987,
      "id": "4",
      "linkedWorkbook": 4,
      "originalGrade": 123,
      "passed": true,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 123,
      "status": "finished",
      "timeElapsedInSeconds": 123,
      "topic": Topic,
      "topicId": 4,
      "topicType": "ad",
      "unansweredQuestionsCount": 123,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

LoadAssessmentAttemptsByTopicOrCourse

Description

Returns assessment attempts by course and/or topic.

Response

Returns [AssessmentAttempt!]!

Arguments
Name Description
courseId - ID The ID of the Course.
topicId - ID The ID of the Topic.

Example

Query
query LoadAssessmentAttemptsByTopicOrCourse(
  $courseId: ID,
  $topicId: ID
) {
  LoadAssessmentAttemptsByTopicOrCourse(
    courseId: $courseId,
    topicId: $topicId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "courseId": "4",
  "topicId": "4"
}
Response
{
  "data": {
    "LoadAssessmentAttemptsByTopicOrCourse": [
      {
        "adminUpdatedGrade": false,
        "answeredQuestionsCount": 123,
        "answers": [AssessmentAnswer],
        "assessment": Assessment,
        "assignmentSubmissionId": "4",
        "correctQuestionsCount": 987,
        "course": "course-1",
        "courseId": "course-1",
        "createdAt": "2007-12-03",
        "forgiven": false,
        "grade": 987,
        "id": 4,
        "linkedWorkbook": 4,
        "originalGrade": 123,
        "passed": true,
        "poolLabelByQuestionId": {},
        "questions": [QuizQuestion],
        "questionsWithChoicesCount": 987,
        "status": "finished",
        "timeElapsedInSeconds": 987,
        "topic": Topic,
        "topicId": "4",
        "topicType": "ad",
        "unansweredQuestionsCount": 123,
        "updatedAt": "2007-12-03",
        "user": User
      }
    ]
  }
}

LoadSuperQuizInfo

Description

This query loads quiz questions and other data about the entered quiz(s). This query allows you to fetch questions for multiple quizzes at the same time.

Response

Returns a SuperQuiz!

Arguments
Name Description
courseId - ID The ID of the Course.
includeCorrectAnswers - Boolean Flag to include questions the user previously got correct.
quizzes - [ID!]! The IDs of the Quizzes user selects.

Example

Query
query LoadSuperQuizInfo(
  $courseId: ID,
  $includeCorrectAnswers: Boolean,
  $quizzes: [ID!]!
) {
  LoadSuperQuizInfo(
    courseId: $courseId,
    includeCorrectAnswers: $includeCorrectAnswers,
    quizzes: $quizzes
  ) {
    displayAllHints
    navigationDisabled
    questionSkipEnabled
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    quizzes
    timePerQuestionInSeconds
    timerEnabled
    totalTimeInSeconds
  }
}
Variables
{
  "courseId": "4",
  "includeCorrectAnswers": true,
  "quizzes": ["4"]
}
Response
{
  "data": {
    "LoadSuperQuizInfo": {
      "displayAllHints": true,
      "navigationDisabled": true,
      "questionSkipEnabled": true,
      "questions": [QuizQuestion],
      "quizzes": [4],
      "timePerQuestionInSeconds": 987,
      "timerEnabled": true,
      "totalTimeInSeconds": 987
    }
  }
}

Pages

Response

Returns [PageResource]!

Arguments
Name Description
identifiers - [String!]!

Example

Query
query Pages($identifiers: [String!]!) {
  Pages(identifiers: $identifiers)
}
Variables
{"identifiers": ["abc123"]}
Response
{"data": {"Pages": [QuizPage]}}

QueryContents

Response

Returns [Content!]!

Arguments
Name Description
ids - [ID!]!

Example

Query
query QueryContents($ids: [ID!]!) {
  QueryContents(ids: $ids) {
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    expiresAt
    hasChildren
    hideCourseDescription
    id
    isActive
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Variables
{"ids": ["4"]}
Response
{
  "data": {
    "QueryContents": [
      {
        "altDescriptionBody": "abc123",
        "alternativePricingRef": 987,
        "alternativePricingType": "membership",
        "asset": "abc123",
        "authors": ["abc123"],
        "authorsAndInstructors": ["abc123"],
        "availabilityStatus": "xyz789",
        "bulkPurchasingEnabled": true,
        "canAddToQueue": false,
        "contentTypeAssetAspectRatio": "xyz789",
        "contentTypeLabel": "xyz789",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": false,
        "courseGroup": "courseGroup-1",
        "coursePresold": true,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "currentUserMayReschedule": false,
        "currentUserUnmetCoursePrerequisites": [
          "4"
        ],
        "currentUserUnmetLearningPathPrerequisites": [4],
        "customFields": {},
        "description": "abc123",
        "displayCourse": 4,
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": true,
        "enrollmentCount": 987,
        "expiresAt": "2007-12-03",
        "hasChildren": false,
        "hideCourseDescription": true,
        "id": 4,
        "isActive": false,
        "kind": "article",
        "language": "abc123",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "abc123",
        "metaTitle": "abc123",
        "priceInCents": 123,
        "publishDate": "2007-12-03",
        "rating": 123,
        "ribbon": Ribbon,
        "seatsLimit": 987,
        "sessionTitle": "xyz789",
        "sku": "xyz789",
        "slug": Slug,
        "source": "abc123",
        "status": "archived",
        "suggestedRetailPriceInCents": 987,
        "tags": [Tag],
        "timeZone": "abc123",
        "title": "xyz789",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 123,
        "waitlistingEnabled": false,
        "waitlistingTriggered": true
      }
    ]
  }
}

RelatedProducts

Response

Returns [Product!]!

Arguments
Name Description
courseIds - [ID!]!
productIds - [ID!]!

Example

Query
query RelatedProducts(
  $courseIds: [ID!]!,
  $productIds: [ID!]!
) {
  RelatedProducts(
    courseIds: $courseIds,
    productIds: $productIds
  ) {
    alternativePricingRef
    alternativePricingType
    asset
    id
    language
    longDescription
    name
    priceInCents
    purchasable
    relatedProducts {
      alternativePricingRef
      alternativePricingType
      asset
      id
      language
      longDescription
      name
      priceInCents
      purchasable
      relatedProducts {
        ...ProductFragment
      }
      status
      suggestedRetailPriceInCents
    }
    status
    suggestedRetailPriceInCents
  }
}
Variables
{"courseIds": [4], "productIds": [4]}
Response
{
  "data": {
    "RelatedProducts": [
      {
        "alternativePricingRef": 987,
        "alternativePricingType": "membership",
        "asset": "http://www.test.com/",
        "id": "4",
        "language": "abc123",
        "longDescription": "abc123",
        "name": "xyz789",
        "priceInCents": 123,
        "purchasable": true,
        "relatedProducts": [Product],
        "status": "archived",
        "suggestedRetailPriceInCents": 987
      }
    ]
  }
}

RssItems

Response

Returns [RssItem!]!

Arguments
Name Description
feedUrl - String!

Example

Query
query RssItems($feedUrl: String!) {
  RssItems(feedUrl: $feedUrl) {
    author
    categories
    date
    description
    id
    imageAltTitle
    imageUrl
    link
    title
  }
}
Variables
{"feedUrl": "xyz789"}
Response
{
  "data": {
    "RssItems": [
      {
        "author": "xyz789",
        "categories": ["xyz789"],
        "date": "2007-12-03",
        "description": "abc123",
        "id": 4,
        "imageAltTitle": "abc123",
        "imageUrl": "abc123",
        "link": "xyz789",
        "title": "xyz789"
      }
    ]
  }
}

RusticiLaunchScorm

Description

Returns data to launch SCORM content through Rustici API.

Response

Returns a RusticiCourseLaunchResponse!

Arguments
Name Description
isPreview - Boolean! Requests the preview URL to launch SCORM content. This requires the current user to be in admin or manager role.
topicOrCourseId - ID! The ID of the Topic Or Course.
type - ContentOrTopicEnum The type of the Topic Or Course.

Example

Query
query RusticiLaunchScorm(
  $isPreview: Boolean!,
  $topicOrCourseId: ID!,
  $type: ContentOrTopicEnum
) {
  RusticiLaunchScorm(
    isPreview: $isPreview,
    topicOrCourseId: $topicOrCourseId,
    type: $type
  ) {
    courseTitle
    fullscreenEmbed
    height
    isRusticiCourse
    registrationCheckerEndpoint
    registrationCheckerJWT
    registrationId
    url
    width
  }
}
Variables
{
  "isPreview": true,
  "topicOrCourseId": "4",
  "type": "course"
}
Response
{
  "data": {
    "RusticiLaunchScorm": {
      "courseTitle": "xyz789",
      "fullscreenEmbed": true,
      "height": 123,
      "isRusticiCourse": false,
      "registrationCheckerEndpoint": "http://www.test.com/",
      "registrationCheckerJWT": "xyz789",
      "registrationId": "4",
      "url": AbsoluteOrRelativeURL,
      "width": 987
    }
  }
}

TermsAndConditions

Response

Returns a TermsAndConditions!

Example

Query
query TermsAndConditions {
  TermsAndConditions {
    globalTerms
  }
}
Response
{
  "data": {
    "TermsAndConditions": {
      "globalTerms": "abc123"
    }
  }
}

UserArchives

Response

Returns [ArchivedContent!]

Example

Query
query UserArchives {
  UserArchives {
    archivedAt
    company {
      appearanceSettings {
        ...AppearanceSettingsFragment
      }
      catalogBlock {
        ...BlockFragment
      }
      catalogVisibilityEmails
      id
      micrositeFooter {
        ...MicrositeBlockFragment
      }
      micrositeHeader {
        ...MicrositeBlockFragment
      }
      name
      organization {
        ...OrganizationFragment
      }
      subdomain
    }
    id
    name
    reinstatable
    resource
    resourceType
    status
    user
    waitlistActive
  }
}
Response
{
  "data": {
    "UserArchives": [
      {
        "archivedAt": "2007-12-03",
        "company": Company,
        "id": "4",
        "name": "xyz789",
        "reinstatable": false,
        "resource": 4,
        "resourceType": "abc123",
        "status": "xyz789",
        "user": 4,
        "waitlistActive": false
      }
    ]
  }
}

UserBookmarks

Response

Returns [BookmarkFolder!]

Example

Query
query UserBookmarks {
  UserBookmarks {
    bookmarkCount
    bookmarks {
      bookmarkFolder {
        ...BookmarkFolderFragment
      }
      course {
        ...CourseFragment
      }
      createdAt
      deleted
      id
      note
      topic {
        ...TopicFragment
      }
      topicId
      user {
        ...UserFragment
      }
    }
    defaultFolder
    deleted
    externalResourceId
    id
    name
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Response
{
  "data": {
    "UserBookmarks": [
      {
        "bookmarkCount": 123,
        "bookmarks": [Bookmark],
        "defaultFolder": false,
        "deleted": false,
        "externalResourceId": "4",
        "id": 4,
        "name": "abc123",
        "user": User
      }
    ]
  }
}

UserBookmarksByFolder

Response

Returns [Bookmark!]

Arguments
Name Description
id - ID!

Example

Query
query UserBookmarksByFolder($id: ID!) {
  UserBookmarksByFolder(id: $id) {
    bookmarkFolder {
      bookmarkCount
      bookmarks {
        ...BookmarkFragment
      }
      defaultFolder
      deleted
      externalResourceId
      id
      name
      user {
        ...UserFragment
      }
    }
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    deleted
    id
    note
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "UserBookmarksByFolder": [
      {
        "bookmarkFolder": BookmarkFolder,
        "course": "course-1",
        "createdAt": "2007-12-03",
        "deleted": true,
        "id": 4,
        "note": "abc123",
        "topic": Topic,
        "topicId": 4,
        "user": User
      }
    ]
  }
}

UserCertificateFields

Response

Returns [CertificateField!]

Example

Query
query UserCertificateFields {
  UserCertificateFields {
    awardType {
      deleted
      icon
      id
      includeOnDashboard
      label
      pluralLabel
    }
    awardTypeId
    customField {
      id
      includeLabelOnContent
      includeValueOnContent
      indexed
      label
      multiple
      slug
      sort
    }
    customFieldSlug
    dateFormat
    hasIdentifierPrefix
    id
    identifierBodyLength
    identifierPrefix
    includeOnExternalCertificate
    includeOnTranscript
    label
    sessionCustomContentFieldSlug
    text
    type
    userCustomField {
      choices
      id
      label
      ref
      required
      slug
      type
    }
    userCustomFieldSlug
  }
}
Response
{
  "data": {
    "UserCertificateFields": [
      {
        "awardType": AwardType,
        "awardTypeId": 4,
        "customField": CustomField,
        "customFieldSlug": Slug,
        "dateFormat": "euroShort",
        "hasIdentifierPrefix": false,
        "id": 4,
        "identifierBodyLength": 123,
        "identifierPrefix": "xyz789",
        "includeOnExternalCertificate": false,
        "includeOnTranscript": true,
        "label": "xyz789",
        "sessionCustomContentFieldSlug": Slug,
        "text": "xyz789",
        "type": "awardLabel",
        "userCustomField": UserCustomField,
        "userCustomFieldSlug": Slug
      }
    ]
  }
}

UserCertificates

Response

Returns [Certificate]

Arguments
Name Description
includeExpiredCertificates - Boolean
query - String

Example

Query
query UserCertificates(
  $includeExpiredCertificates: Boolean,
  $query: String
) {
  UserCertificates(
    includeExpiredCertificates: $includeExpiredCertificates,
    query: $query
  ) {
    certificateTemplate {
      asset
      assetLibraryId
      customCss
      expirationDate
      expirationDays
      id
      isExpired
      labels {
        ...CertificateTemplateLabelFragment
      }
      recertificationAction
      recertificationActionText
      recertificationActionUrl
      recertificationAfterDays
      recertificationAutoReset
      recertificationInstructions
      resource
      resourceType
      supplementalAssets
      title
      userCustomField {
        ...UserCustomFieldFragment
      }
      userCustomFieldSlug
      userCustomFieldValue
    }
    contentItem {
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      expiresAt
      hasChildren
      hideCourseDescription
      id
      isActive
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    deleted
    didExpire
    expirationDate
    externalResourceTitle
    id
    identifier
    isExpired
    isExternal
    issuedAt
    pdfAsset
    progressWasReset
    recertificationDate
    resource
    resourceId
    resourceType
    resourceTypeLabel
    source
    url
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "includeExpiredCertificates": false,
  "query": "xyz789"
}
Response
{
  "data": {
    "UserCertificates": [
      {
        "certificateTemplate": CertificateTemplate,
        "contentItem": Content,
        "deleted": false,
        "didExpire": true,
        "expirationDate": "2007-12-03",
        "externalResourceTitle": "xyz789",
        "id": "4",
        "identifier": "abc123",
        "isExpired": true,
        "isExternal": false,
        "issuedAt": "2007-12-03",
        "pdfAsset": AbsoluteOrRelativeURL,
        "progressWasReset": true,
        "recertificationDate": "2007-12-03",
        "resource": Course,
        "resourceId": 4,
        "resourceType": "course",
        "resourceTypeLabel": "abc123",
        "source": "abc123",
        "url": AbsoluteOrRelativeURL,
        "user": User
      }
    ]
  }
}

UserContentGroups

Response

Returns [ContentGroup!]

Arguments
Name Description
includeExpiredCertificates - Boolean
query - String

Example

Query
query UserContentGroups(
  $includeExpiredCertificates: Boolean,
  $query: String
) {
  UserContentGroups(
    includeExpiredCertificates: $includeExpiredCertificates,
    query: $query
  ) {
    count
    kind
  }
}
Variables
{
  "includeExpiredCertificates": true,
  "query": "abc123"
}
Response
{
  "data": {
    "UserContentGroups": [{"count": 987, "kind": "archivedContentItems"}]
  }
}

UserContentItems

Response

Returns [Content!]

Arguments
Name Description
kind - [String!]
query - String
sort - String

Example

Query
query UserContentItems(
  $kind: [String!],
  $query: String,
  $sort: String
) {
  UserContentItems(
    kind: $kind,
    query: $query,
    sort: $sort
  ) {
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    expiresAt
    hasChildren
    hideCourseDescription
    id
    isActive
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Variables
{
  "kind": ["xyz789"],
  "query": "xyz789",
  "sort": "abc123"
}
Response
{
  "data": {
    "UserContentItems": [
      {
        "altDescriptionBody": "abc123",
        "alternativePricingRef": 987,
        "alternativePricingType": "membership",
        "asset": "xyz789",
        "authors": ["xyz789"],
        "authorsAndInstructors": ["abc123"],
        "availabilityStatus": "xyz789",
        "bulkPurchasingEnabled": false,
        "canAddToQueue": false,
        "contentTypeAssetAspectRatio": "xyz789",
        "contentTypeLabel": "abc123",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": true,
        "courseGroup": "courseGroup-1",
        "coursePresold": true,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "currentUserMayReschedule": true,
        "currentUserUnmetCoursePrerequisites": [
          "4"
        ],
        "currentUserUnmetLearningPathPrerequisites": [
          "4"
        ],
        "customFields": {},
        "description": "abc123",
        "displayCourse": "4",
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": false,
        "enrollmentCount": 987,
        "expiresAt": "2007-12-03",
        "hasChildren": false,
        "hideCourseDescription": true,
        "id": 4,
        "isActive": true,
        "kind": "article",
        "language": "abc123",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "xyz789",
        "metaTitle": "abc123",
        "priceInCents": 987,
        "publishDate": "2007-12-03",
        "rating": 987,
        "ribbon": Ribbon,
        "seatsLimit": 987,
        "sessionTitle": "xyz789",
        "sku": "xyz789",
        "slug": Slug,
        "source": "xyz789",
        "status": "archived",
        "suggestedRetailPriceInCents": 123,
        "tags": [Tag],
        "timeZone": "xyz789",
        "title": "xyz789",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 123,
        "waitlistingEnabled": true,
        "waitlistingTriggered": false
      }
    ]
  }
}

UserCourseAwardCounts

Response

Returns [UserAwardCount!]!

Arguments
Name Description
courseId - ID! The ID of the Course.

Example

Query
query UserCourseAwardCounts($courseId: ID!) {
  UserCourseAwardCounts(courseId: $courseId) {
    count
    icon
    id
    label
  }
}
Variables
{"courseId": 4}
Response
{
  "data": {
    "UserCourseAwardCounts": [
      {
        "count": 123,
        "icon": "businessuser",
        "id": 4,
        "label": "xyz789"
      }
    ]
  }
}

UserCourseCollaborations

Response

Returns an Int!

Arguments
Name Description
courseId - ID! The ID of the Course.

Example

Query
query UserCourseCollaborations($courseId: ID!) {
  UserCourseCollaborations(courseId: $courseId)
}
Variables
{"courseId": "4"}
Response
{"data": {"UserCourseCollaborations": 123}}

UserCourseCompletionProgress

Arguments
Name Description
id - ID!

Example

Query
query UserCourseCompletionProgress($id: ID!) {
  UserCourseCompletionProgress(id: $id) {
    completed
    percent
    required
    type
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "UserCourseCompletionProgress": [
      {
        "completed": [4],
        "percent": 123,
        "required": [4],
        "type": "articlePercentViewed"
      }
    ]
  }
}

UserCourseProgress

Response

Returns a UserProgress

Arguments
Name Description
id - ID!

Example

Query
query UserCourseProgress($id: ID!) {
  UserCourseProgress(id: $id) {
    percentComplete
    totalTime
    totalViews
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "UserCourseProgress": {
      "percentComplete": 123,
      "totalTime": 123,
      "totalViews": 123
    }
  }
}

UserEarnedBadgeBoard

Response

Returns an EarnedBadgeBoard!

Example

Query
query UserEarnedBadgeBoard {
  UserEarnedBadgeBoard {
    earnedBadges {
      badge {
        ...BadgeFragment
      }
      deleted
      id
      user {
        ...UserFragment
      }
    }
    unearnedBadges {
      asset
      awardThreshold
      awardType {
        ...AwardTypeFragment
      }
      deleted
      id
      label
    }
  }
}
Response
{
  "data": {
    "UserEarnedBadgeBoard": {
      "earnedBadges": [EarnedBadge],
      "unearnedBadges": [Badge]
    }
  }
}

UserRecentContent

Response

Returns [Content!]!

Arguments
Name Description
limit - Int

Example

Query
query UserRecentContent($limit: Int) {
  UserRecentContent(limit: $limit) {
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    expiresAt
    hasChildren
    hideCourseDescription
    id
    isActive
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Variables
{"limit": 987}
Response
{
  "data": {
    "UserRecentContent": [
      {
        "altDescriptionBody": "xyz789",
        "alternativePricingRef": 123,
        "alternativePricingType": "membership",
        "asset": "abc123",
        "authors": ["xyz789"],
        "authorsAndInstructors": ["xyz789"],
        "availabilityStatus": "abc123",
        "bulkPurchasingEnabled": true,
        "canAddToQueue": true,
        "contentTypeAssetAspectRatio": "abc123",
        "contentTypeLabel": "xyz789",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": false,
        "courseGroup": "courseGroup-1",
        "coursePresold": true,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "currentUserMayReschedule": true,
        "currentUserUnmetCoursePrerequisites": [4],
        "currentUserUnmetLearningPathPrerequisites": [4],
        "customFields": {},
        "description": "xyz789",
        "displayCourse": "4",
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": true,
        "enrollmentCount": 987,
        "expiresAt": "2007-12-03",
        "hasChildren": false,
        "hideCourseDescription": true,
        "id": "4",
        "isActive": false,
        "kind": "article",
        "language": "xyz789",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "xyz789",
        "metaTitle": "xyz789",
        "priceInCents": 987,
        "publishDate": "2007-12-03",
        "rating": 123,
        "ribbon": Ribbon,
        "seatsLimit": 987,
        "sessionTitle": "xyz789",
        "sku": "xyz789",
        "slug": Slug,
        "source": "abc123",
        "status": "archived",
        "suggestedRetailPriceInCents": 123,
        "tags": [Tag],
        "timeZone": "xyz789",
        "title": "abc123",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 123,
        "waitlistingEnabled": false,
        "waitlistingTriggered": true
      }
    ]
  }
}

UserWaitlist

Response

Returns [Content!]

Example

Query
query UserWaitlist {
  UserWaitlist {
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    expiresAt
    hasChildren
    hideCourseDescription
    id
    isActive
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Response
{
  "data": {
    "UserWaitlist": [
      {
        "altDescriptionBody": "xyz789",
        "alternativePricingRef": 123,
        "alternativePricingType": "membership",
        "asset": "xyz789",
        "authors": ["abc123"],
        "authorsAndInstructors": ["xyz789"],
        "availabilityStatus": "abc123",
        "bulkPurchasingEnabled": false,
        "canAddToQueue": false,
        "contentTypeAssetAspectRatio": "xyz789",
        "contentTypeLabel": "abc123",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": false,
        "courseGroup": "courseGroup-1",
        "coursePresold": true,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "currentUserMayReschedule": false,
        "currentUserUnmetCoursePrerequisites": [4],
        "currentUserUnmetLearningPathPrerequisites": [
          "4"
        ],
        "customFields": {},
        "description": "abc123",
        "displayCourse": 4,
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": true,
        "enrollmentCount": 123,
        "expiresAt": "2007-12-03",
        "hasChildren": true,
        "hideCourseDescription": false,
        "id": 4,
        "isActive": false,
        "kind": "article",
        "language": "abc123",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "xyz789",
        "metaTitle": "abc123",
        "priceInCents": 123,
        "publishDate": "2007-12-03",
        "rating": 987,
        "ribbon": Ribbon,
        "seatsLimit": 123,
        "sessionTitle": "abc123",
        "sku": "abc123",
        "slug": Slug,
        "source": "xyz789",
        "status": "archived",
        "suggestedRetailPriceInCents": 987,
        "tags": [Tag],
        "timeZone": "abc123",
        "title": "xyz789",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 987,
        "waitlistingEnabled": false,
        "waitlistingTriggered": true
      }
    ]
  }
}

Mutations

AddResourceToQueue

Response

Returns a Boolean!

Arguments
Name Description
resourceId - ID! The ID of the Resource.
resourceType - ContentKind

Example

Query
mutation AddResourceToQueue(
  $resourceId: ID!,
  $resourceType: ContentKind
) {
  AddResourceToQueue(
    resourceId: $resourceId,
    resourceType: $resourceType
  )
}
Variables
{
  "resourceId": "4",
  "resourceType": "article"
}
Response
{"data": {"AddResourceToQueue": true}}

ArchiveUserCourse

Description

Archives a user's access to a course.

Response

Returns an ID

Arguments
Name Description
id - ID! The ID of the course to be archived.

Example

Query
mutation ArchiveUserCourse($id: ID!) {
  ArchiveUserCourse(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"ArchiveUserCourse": "4"}}

ArchiveUserLearningPath

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation ArchiveUserLearningPath($id: ID!) {
  ArchiveUserLearningPath(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"ArchiveUserLearningPath": "4"}}

CreateAssessmentAttempt

Description

Creates an assessment attempt for a course assessment. This is used to create a super quiz attempt with user's selected questions.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
courseId - ID! The ID of the Course.
questions - [QuestionInput!]! The questions user selected for super quiz.
topicId - ID! The ID of the Topic.

Example

Query
mutation CreateAssessmentAttempt(
  $courseId: ID!,
  $questions: [QuestionInput!]!,
  $topicId: ID!
) {
  CreateAssessmentAttempt(
    courseId: $courseId,
    questions: $questions,
    topicId: $topicId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "courseId": "4",
  "questions": [QuestionInput],
  "topicId": 4
}
Response
{
  "data": {
    "CreateAssessmentAttempt": {
      "adminUpdatedGrade": false,
      "answeredQuestionsCount": 123,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": "4",
      "correctQuestionsCount": 123,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": false,
      "grade": 123,
      "id": 4,
      "linkedWorkbook": 4,
      "originalGrade": 123,
      "passed": true,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 987,
      "status": "finished",
      "timeElapsedInSeconds": 987,
      "topic": Topic,
      "topicId": "4",
      "topicType": "ad",
      "unansweredQuestionsCount": 123,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

CreateAssignmentSubmission

Description

Creates an assignment submission. This is used when user works on a manually graded assessment, the assessment attempt will be associated with the assignment submission.

Response

Returns an AssignmentSubmission!

Arguments
Name Description
asset - String The URL of the asset.
assignment - ID The ID of the assignment.
body - String The body of the assignment submission.
course - ID! The ID of the course.
quizAttempt - ID The ID of the assessment attempt.
videoAsset - String The URL of the video asset.

Example

Query
mutation CreateAssignmentSubmission(
  $asset: String,
  $assignment: ID,
  $body: String,
  $course: ID!,
  $quizAttempt: ID,
  $videoAsset: String
) {
  CreateAssignmentSubmission(
    asset: $asset,
    assignment: $assignment,
    body: $body,
    course: $course,
    quizAttempt: $quizAttempt,
    videoAsset: $videoAsset
  ) {
    adminUpdatedGrade
    asset
    assignment {
      id
      title
    }
    body
    commentsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    grade
    gradeFeedback
    id
    numericGrade
    quizAttempt {
      adminUpdatedGrade
      answeredQuestionsCount
      answers {
        ...AssessmentAnswerFragment
      }
      assessment {
        ...AssessmentFragment
      }
      assignmentSubmissionId
      correctQuestionsCount
      course {
        ...CourseFragment
      }
      courseId
      createdAt
      forgiven
      grade
      id
      linkedWorkbook
      originalGrade
      passed
      poolLabelByQuestionId
      questions {
        ...QuizQuestionFragment
      }
      questionsWithChoicesCount
      status
      timeElapsedInSeconds
      topic {
        ...TopicFragment
      }
      topicId
      topicType
      unansweredQuestionsCount
      updatedAt
      user {
        ...UserFragment
      }
    }
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
    videoAsset
  }
}
Variables
{
  "asset": "xyz789",
  "assignment": 4,
  "body": "xyz789",
  "course": 4,
  "quizAttempt": "4",
  "videoAsset": "xyz789"
}
Response
{
  "data": {
    "CreateAssignmentSubmission": {
      "adminUpdatedGrade": false,
      "asset": "http://www.test.com/",
      "assignment": Assignment,
      "body": "xyz789",
      "commentsCount": 987,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "grade": "completed",
      "gradeFeedback": "abc123",
      "id": 4,
      "numericGrade": 987.65,
      "quizAttempt": AssessmentAttempt,
      "updatedAt": "2007-12-03",
      "user": User,
      "videoAsset": "abc123"
    }
  }
}

CreateCertificateFromUpload

Response

Returns a Certificate!

Arguments
Name Description
asset - URL!
certificateUploadFields - [CertificateUploadField!]

Example

Query
mutation CreateCertificateFromUpload(
  $asset: URL!,
  $certificateUploadFields: [CertificateUploadField!]
) {
  CreateCertificateFromUpload(
    asset: $asset,
    certificateUploadFields: $certificateUploadFields
  ) {
    certificateTemplate {
      asset
      assetLibraryId
      customCss
      expirationDate
      expirationDays
      id
      isExpired
      labels {
        ...CertificateTemplateLabelFragment
      }
      recertificationAction
      recertificationActionText
      recertificationActionUrl
      recertificationAfterDays
      recertificationAutoReset
      recertificationInstructions
      resource
      resourceType
      supplementalAssets
      title
      userCustomField {
        ...UserCustomFieldFragment
      }
      userCustomFieldSlug
      userCustomFieldValue
    }
    contentItem {
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      expiresAt
      hasChildren
      hideCourseDescription
      id
      isActive
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    deleted
    didExpire
    expirationDate
    externalResourceTitle
    id
    identifier
    isExpired
    isExternal
    issuedAt
    pdfAsset
    progressWasReset
    recertificationDate
    resource
    resourceId
    resourceType
    resourceTypeLabel
    source
    url
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "asset": "http://www.test.com/",
  "certificateUploadFields": [CertificateUploadField]
}
Response
{
  "data": {
    "CreateCertificateFromUpload": {
      "certificateTemplate": CertificateTemplate,
      "contentItem": Content,
      "deleted": true,
      "didExpire": true,
      "expirationDate": "2007-12-03",
      "externalResourceTitle": "abc123",
      "id": 4,
      "identifier": "xyz789",
      "isExpired": true,
      "isExternal": true,
      "issuedAt": "2007-12-03",
      "pdfAsset": AbsoluteOrRelativeURL,
      "progressWasReset": false,
      "recertificationDate": "2007-12-03",
      "resource": Course,
      "resourceId": 4,
      "resourceType": "course",
      "resourceTypeLabel": "abc123",
      "source": "abc123",
      "url": AbsoluteOrRelativeURL,
      "user": User
    }
  }
}

CreateComment

Description

Creates a comment.

Response

Returns a Comment!

Arguments
Name Description
asset - URL The URL of the asset.
assetFileName - String The file name of the asset.
body - String The body of the comment.
clientId - ID The ID of the Client.
commentableId - ID! The ID of the commentable entity.
commentableType - CommentableType! The type of the commentable entity.
notificationsEnabled - Boolean! Flag to enable notifications.
parentId - ID The ID of the parent comment.
videoAsset - ID The ID of the video asset.

Example

Query
mutation CreateComment(
  $asset: URL,
  $assetFileName: String,
  $body: String,
  $clientId: ID,
  $commentableId: ID!,
  $commentableType: CommentableType!,
  $notificationsEnabled: Boolean!,
  $parentId: ID,
  $videoAsset: ID
) {
  CreateComment(
    asset: $asset,
    assetFileName: $assetFileName,
    body: $body,
    clientId: $clientId,
    commentableId: $commentableId,
    commentableType: $commentableType,
    notificationsEnabled: $notificationsEnabled,
    parentId: $parentId,
    videoAsset: $videoAsset
  ) {
    asset
    assetFileName
    body
    childComments {
      comments {
        ...CommentFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
    }
    commentable
    commentableId
    commentableType
    createdAt
    id
    likesCount
    notificationsEnabled
    parentComment {
      asset
      assetFileName
      body
      childComments {
        ...CommentsListFragment
      }
      commentable
      commentableId
      commentableType
      createdAt
      id
      likesCount
      notificationsEnabled
      parentComment {
        ...CommentFragment
      }
      updatedAt
      user {
        ...UserFragment
      }
      userLikeId
      videoAsset
    }
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
    userLikeId
    videoAsset
  }
}
Variables
{
  "asset": "http://www.test.com/",
  "assetFileName": "xyz789",
  "body": "abc123",
  "clientId": "4",
  "commentableId": 4,
  "commentableType": "assignment",
  "notificationsEnabled": true,
  "parentId": "4",
  "videoAsset": "4"
}
Response
{
  "data": {
    "CreateComment": {
      "asset": "http://www.test.com/",
      "assetFileName": "xyz789",
      "body": "xyz789",
      "childComments": CommentsList,
      "commentable": Thread,
      "commentableId": 4,
      "commentableType": "assignment",
      "createdAt": "2007-12-03",
      "id": 4,
      "likesCount": 987,
      "notificationsEnabled": false,
      "parentComment": Comment,
      "updatedAt": "2007-12-03",
      "user": User,
      "userLikeId": 4,
      "videoAsset": "4"
    }
  }
}

CreateUnansweredAssessmentAttempt

Description

Creates an assessment attempt for unanswered questions. This is used when user skips questions during an assessment attempt and decides to review the unanswered questions.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
completedAssessmentAttemptId - ID! The ID of the last completed assessment attempt.
courseId - ID! The ID of the Course.
topicId - ID! The ID of the Topic.

Example

Query
mutation CreateUnansweredAssessmentAttempt(
  $completedAssessmentAttemptId: ID!,
  $courseId: ID!,
  $topicId: ID!
) {
  CreateUnansweredAssessmentAttempt(
    completedAssessmentAttemptId: $completedAssessmentAttemptId,
    courseId: $courseId,
    topicId: $topicId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{"completedAssessmentAttemptId": 4, "courseId": 4, "topicId": 4}
Response
{
  "data": {
    "CreateUnansweredAssessmentAttempt": {
      "adminUpdatedGrade": true,
      "answeredQuestionsCount": 987,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": 4,
      "correctQuestionsCount": 123,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": false,
      "grade": 123,
      "id": 4,
      "linkedWorkbook": "4",
      "originalGrade": 123,
      "passed": true,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 123,
      "status": "finished",
      "timeElapsedInSeconds": 987,
      "topic": Topic,
      "topicId": "4",
      "topicType": "ad",
      "unansweredQuestionsCount": 123,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

DestroyBookmark

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation DestroyBookmark($id: ID!) {
  DestroyBookmark(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"DestroyBookmark": 4}}

DestroyBookmarkFolder

Response

Returns an ID!

Arguments
Name Description
id - ID!

Example

Query
mutation DestroyBookmarkFolder($id: ID!) {
  DestroyBookmarkFolder(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"DestroyBookmarkFolder": "4"}}

Login

Description

Attempts to login the user. The mutation will perform a number of checks such as password validity and email verification status. If successful, the user will be logged in and an authentication token returned. If not, an appropriate error will be provided.

Response

Returns a String!

Arguments
Name Description
email - String! The email of the Current User attempting to log in.
password - String! The password of the Current User attempting to log in.

Example

Query
mutation Login(
  $email: String!,
  $password: String!
) {
  Login(
    email: $email,
    password: $password
  )
}
Variables
{
  "email": "xyz789",
  "password": "xyz789"
}
Response
{"data": {"Login": "xyz789"}}

MergeAssessmentAttemptIntoComplete

Description

Merges an assessment attempt into the last completed assessment attempt. This is used after user finishes reviewing the unanswered questions, the current assessment attempt will be merged to the last completed assessment attempt.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
assessmentAttemptId - ID! The ID of the Assessment Attempt.
completedAssessmentAttemptId - ID! The ID of the last completed assessment attempt.

Example

Query
mutation MergeAssessmentAttemptIntoComplete(
  $assessmentAttemptId: ID!,
  $completedAssessmentAttemptId: ID!
) {
  MergeAssessmentAttemptIntoComplete(
    assessmentAttemptId: $assessmentAttemptId,
    completedAssessmentAttemptId: $completedAssessmentAttemptId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{"assessmentAttemptId": 4, "completedAssessmentAttemptId": 4}
Response
{
  "data": {
    "MergeAssessmentAttemptIntoComplete": {
      "adminUpdatedGrade": true,
      "answeredQuestionsCount": 987,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": 4,
      "correctQuestionsCount": 987,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": true,
      "grade": 123,
      "id": "4",
      "linkedWorkbook": "4",
      "originalGrade": 987,
      "passed": false,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 987,
      "status": "finished",
      "timeElapsedInSeconds": 123,
      "topic": Topic,
      "topicId": "4",
      "topicType": "ad",
      "unansweredQuestionsCount": 123,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

OrderBookmarkFolders

Response

Returns [String!]

Arguments
Name Description
ids - [ID!]

Example

Query
mutation OrderBookmarkFolders($ids: [ID!]) {
  OrderBookmarkFolders(ids: $ids)
}
Variables
{"ids": [4]}
Response
{
  "data": {
    "OrderBookmarkFolders": ["xyz789"]
  }
}

RedeemRegistrationAndRedemptionCodes

Arguments
Name Description
validatedRedemptionCodes - [String!]!

Example

Query
mutation RedeemRegistrationAndRedemptionCodes($validatedRedemptionCodes: [String!]!) {
  RedeemRegistrationAndRedemptionCodes(validatedRedemptionCodes: $validatedRedemptionCodes) {
    redeemed
  }
}
Variables
{"validatedRedemptionCodes": ["abc123"]}
Response
{"data": {"RedeemRegistrationAndRedemptionCodes": {"redeemed": true}}}

ReinstateUserCourse

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation ReinstateUserCourse($id: ID!) {
  ReinstateUserCourse(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"ReinstateUserCourse": 4}}

ReinstateUserLearningPath

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation ReinstateUserLearningPath($id: ID!) {
  ReinstateUserLearningPath(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"ReinstateUserLearningPath": 4}}

UnenrollFromWaitlist

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation UnenrollFromWaitlist($id: ID!) {
  UnenrollFromWaitlist(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"UnenrollFromWaitlist": true}}

UpdateAssessmentAttempt

Description

Updates an assessment attempt. This is used to record user's selected choice(s) for the active question, or to record when user finishes the assessment.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
activeQuestion - QuestionInput The active question with user's selected choice(s).
assessmentAttempt - AssessmentAttemptInput The assessment attempt to be updated.

Example

Query
mutation UpdateAssessmentAttempt(
  $activeQuestion: QuestionInput,
  $assessmentAttempt: AssessmentAttemptInput
) {
  UpdateAssessmentAttempt(
    activeQuestion: $activeQuestion,
    assessmentAttempt: $assessmentAttempt
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "activeQuestion": QuestionInput,
  "assessmentAttempt": AssessmentAttemptInput
}
Response
{
  "data": {
    "UpdateAssessmentAttempt": {
      "adminUpdatedGrade": false,
      "answeredQuestionsCount": 123,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": "4",
      "correctQuestionsCount": 123,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": false,
      "grade": 987,
      "id": 4,
      "linkedWorkbook": "4",
      "originalGrade": 123,
      "passed": true,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 987,
      "status": "finished",
      "timeElapsedInSeconds": 123,
      "topic": Topic,
      "topicId": "4",
      "topicType": "ad",
      "unansweredQuestionsCount": 123,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

UpdateBookmark

Response

Returns a Bookmark!

Arguments
Name Description
bookmarkFolder - ID!
id - ID!
note - String

Example

Query
mutation UpdateBookmark(
  $bookmarkFolder: ID!,
  $id: ID!,
  $note: String
) {
  UpdateBookmark(
    bookmarkFolder: $bookmarkFolder,
    id: $id,
    note: $note
  ) {
    bookmarkFolder {
      bookmarkCount
      bookmarks {
        ...BookmarkFragment
      }
      defaultFolder
      deleted
      externalResourceId
      id
      name
      user {
        ...UserFragment
      }
    }
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    deleted
    id
    note
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "bookmarkFolder": "4",
  "id": 4,
  "note": "abc123"
}
Response
{
  "data": {
    "UpdateBookmark": {
      "bookmarkFolder": BookmarkFolder,
      "course": "course-1",
      "createdAt": "2007-12-03",
      "deleted": true,
      "id": "4",
      "note": "xyz789",
      "topic": Topic,
      "topicId": "4",
      "user": User
    }
  }
}

UpdateBookmarkFolder

Response

Returns a BookmarkFolder!

Arguments
Name Description
id - ID!
name - String!

Example

Query
mutation UpdateBookmarkFolder(
  $id: ID!,
  $name: String!
) {
  UpdateBookmarkFolder(
    id: $id,
    name: $name
  ) {
    bookmarkCount
    bookmarks {
      bookmarkFolder {
        ...BookmarkFolderFragment
      }
      course {
        ...CourseFragment
      }
      createdAt
      deleted
      id
      note
      topic {
        ...TopicFragment
      }
      topicId
      user {
        ...UserFragment
      }
    }
    defaultFolder
    deleted
    externalResourceId
    id
    name
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{"id": 4, "name": "abc123"}
Response
{
  "data": {
    "UpdateBookmarkFolder": {
      "bookmarkCount": 123,
      "bookmarks": [Bookmark],
      "defaultFolder": true,
      "deleted": false,
      "externalResourceId": "4",
      "id": 4,
      "name": "abc123",
      "user": User
    }
  }
}

UpdateLearningPathAccess

Response

Returns a Boolean!

Arguments
Name Description
slug - Slug!
status - String!

Example

Query
mutation UpdateLearningPathAccess(
  $slug: Slug!,
  $status: String!
) {
  UpdateLearningPathAccess(
    slug: $slug,
    status: $status
  )
}
Variables
{
  "slug": Slug,
  "status": "abc123"
}
Response
{"data": {"UpdateLearningPathAccess": false}}

ValidateRedemptionCode

Response

Returns a ValidateRedemptionCodeResult!

Arguments
Name Description
code - String!

Example

Query
mutation ValidateRedemptionCode($code: String!) {
  ValidateRedemptionCode(code: $code) {
    alreadyRedeemed
    codeExpired
    valid
  }
}
Variables
{"code": "xyz789"}
Response
{
  "data": {
    "ValidateRedemptionCode": {
      "alreadyRedeemed": true,
      "codeExpired": true,
      "valid": false
    }
  }
}

ValidateRegistrationCode

Response

Returns a ValidateRegistrationCodeResult!

Arguments
Name Description
code - String!

Example

Query
mutation ValidateRegistrationCode($code: String!) {
  ValidateRegistrationCode(code: $code) {
    alreadyRedeemed
    valid
  }
}
Variables
{"code": "xyz789"}
Response
{
  "data": {
    "ValidateRegistrationCode": {"alreadyRedeemed": false, "valid": true}
  }
}

Types

AbsoluteOrRelativeURL

Description

A valid absolute (starting with either a valid protocol or a leading www) or relative (with a leading slash) URL string

Example
AbsoluteOrRelativeURL

AccessLevel

Values
Enum Value Description

emailCaptureOpen

open

studentsOnly

Example
"emailCaptureOpen"

Aggregation

Fields
Field Name Description
buckets - [AggregationBucket]
key - String
label - String
Example
{
  "buckets": [AggregationBucket],
  "key": "xyz789",
  "label": "xyz789"
}

AggregationBucket

Fields
Field Name Description
count - Int
description - String
label - String
query - String
value - String
Example
{
  "count": 987,
  "description": "abc123",
  "label": "xyz789",
  "query": "xyz789",
  "value": "xyz789"
}

AllocatedLearningPath

Fields
Field Name Description
learningPath - LearningPath The ID of the Learning Path.
learningPathId - ID!
Example
{"learningPath": "learning-path-1", "learningPathId": "learning-path-1"}

AllocatedLicense

Fields
Field Name Description
license - License The ID of the License.
licenseId - ID!
licenseRole - AllocatedLicenseRole!
status - String
Example
{
  "license": "license-1",
  "licenseId": "license-1",
  "licenseRole": "manager",
  "status": "abc123"
}

AllocatedLicenseRole

Values
Enum Value Description

manager

student

Example
"manager"

AlternativePricingType

Values
Enum Value Description

membership

Example
"membership"

AppearanceSettings

Fields
Field Name Description
accentColor - HexColor
altFont - String
backgroundAsset - String
backgroundAssetTiled - Boolean
company - Company
customCss - String
font - String
globalNavigationLinks - [GlobalNavigationLink]
id - ID! The ID of the Appearance Settings.
linkColor - HexColor
logoAsset - URL
retinaLogo - Boolean
secondaryColor - HexColor
Example
{
  "accentColor": HexColor,
  "altFont": "xyz789",
  "backgroundAsset": "xyz789",
  "backgroundAssetTiled": true,
  "company": Company,
  "customCss": "abc123",
  "font": "xyz789",
  "globalNavigationLinks": [GlobalNavigationLink],
  "id": "4",
  "linkColor": HexColor,
  "logoAsset": "http://www.test.com/",
  "retinaLogo": true,
  "secondaryColor": HexColor
}

ArchivedContent

Fields
Field Name Description
archivedAt - Date
company - Company
id - ID! The ID of the Archived Content.
name - String
reinstatable - Boolean!
resource - ID The ID of the Resource.
resourceType - String
status - String
user - ID The ID of the User.
waitlistActive - Boolean!
Example
{
  "archivedAt": "2007-12-03",
  "company": Company,
  "id": "4",
  "name": "abc123",
  "reinstatable": false,
  "resource": "4",
  "resourceType": "abc123",
  "status": "abc123",
  "user": 4,
  "waitlistActive": true
}

Assessment

Fields
Field Name Description
id - ID! The ID of the Assessment.
minPassingPercent - Int
title - String
type - String
Example
{
  "id": "4",
  "minPassingPercent": 987,
  "title": "xyz789",
  "type": "abc123"
}

AssessmentAnswer

Fields
Field Name Description
answer - String
correct - Boolean!
hasDefaultGrade - Boolean
id - ID! The ID of the Assessment Answer.
question - String
Example
{
  "answer": "xyz789",
  "correct": false,
  "hasDefaultGrade": false,
  "id": "4",
  "question": "xyz789"
}

AssessmentAttempt

Fields
Field Name Description
adminUpdatedGrade - Boolean!
answeredQuestionsCount - Int
answers - [AssessmentAnswer!]
assessment - Assessment
assignmentSubmissionId - ID The ID of the Assignment Submission.
correctQuestionsCount - Int
course - Course The ID of the Course.
courseId - ID The ID of the Course.
createdAt - Date The time the field was created.
forgiven - Boolean!
grade - Int
id - ID! The ID of the Assessment Attempt.
linkedWorkbook - ID The ID of the Linked Workbook.
originalGrade - Int
passed - Boolean!
poolLabelByQuestionId - JSON
questions - [QuizQuestion!]
questionsWithChoicesCount - Int
status - AssessmentAttemptStatus!
timeElapsedInSeconds - Int
topic - Topic
topicId - ID The ID of the Topic.
topicType - TopicType
unansweredQuestionsCount - Int
updatedAt - Date The time the field was updated.
user - User
Example
{
  "adminUpdatedGrade": false,
  "answeredQuestionsCount": 123,
  "answers": [AssessmentAnswer],
  "assessment": Assessment,
  "assignmentSubmissionId": 4,
  "correctQuestionsCount": 123,
  "course": "course-1",
  "courseId": "course-1",
  "createdAt": "2007-12-03",
  "forgiven": true,
  "grade": 987,
  "id": "4",
  "linkedWorkbook": 4,
  "originalGrade": 987,
  "passed": true,
  "poolLabelByQuestionId": {},
  "questions": [QuizQuestion],
  "questionsWithChoicesCount": 123,
  "status": "finished",
  "timeElapsedInSeconds": 987,
  "topic": Topic,
  "topicId": "4",
  "topicType": "ad",
  "unansweredQuestionsCount": 123,
  "updatedAt": "2007-12-03",
  "user": User
}

AssessmentAttemptInput

Fields
Input Field Description
answeredQuestionsCount - Int
assignmentSubmission - ID
correctQuestionsCount - Int
forgiven - Boolean
grade - Int
id - ID!
passed - Boolean
poolLabelByQuestionId - JSON
questions - [QuestionInput!]
questionsWithChoicesCount - Int
status - AssessmentAttemptStatus!
timeElapsedInSeconds - Int
topicType - TopicType
unansweredQuestionsCount - Int
Example
{
  "answeredQuestionsCount": 123,
  "assignmentSubmission": 4,
  "correctQuestionsCount": 123,
  "forgiven": false,
  "grade": 123,
  "id": 4,
  "passed": true,
  "poolLabelByQuestionId": {},
  "questions": [QuestionInput],
  "questionsWithChoicesCount": 123,
  "status": "finished",
  "timeElapsedInSeconds": 987,
  "topicType": "ad",
  "unansweredQuestionsCount": 123
}

AssessmentAttemptStatus

Values
Enum Value Description

finished

pending

started

Example
"finished"

Assignment

Fields
Field Name Description
id - ID! The ID of the Assignment.
title - String
Example
{"id": 4, "title": "xyz789"}

AssignmentSubmission

Fields
Field Name Description
adminUpdatedGrade - Boolean!
asset - URL
assignment - Assignment
body - String
commentsCount - Int!
course - Course The ID of the Course.
courseId - ID The ID of the Course.
createdAt - Date The time the field was created.
grade - AssignmentSubmissionGrade
gradeFeedback - String
id - ID! The ID of the Assignment Submission.
numericGrade - Float
quizAttempt - AssessmentAttempt
updatedAt - Date The time the field was updated.
user - User
videoAsset - String
Example
{
  "adminUpdatedGrade": true,
  "asset": "http://www.test.com/",
  "assignment": Assignment,
  "body": "abc123",
  "commentsCount": 987,
  "course": "course-1",
  "courseId": "course-1",
  "createdAt": "2007-12-03",
  "grade": "completed",
  "gradeFeedback": "abc123",
  "id": "4",
  "numericGrade": 987.65,
  "quizAttempt": AssessmentAttempt,
  "updatedAt": "2007-12-03",
  "user": User,
  "videoAsset": "xyz789"
}

AssignmentSubmissionGrade

Values
Enum Value Description

completed

incomplete

Example
"completed"

AwardType

Fields
Field Name Description
deleted - Boolean Returns true when the Award Type is deleted.
icon - AwardTypeIcon
id - ID! The ID of the Award Type.
includeOnDashboard - Boolean
label - String
pluralLabel - String
Example
{
  "deleted": false,
  "icon": "businessuser",
  "id": "4",
  "includeOnDashboard": true,
  "label": "abc123",
  "pluralLabel": "abc123"
}

AwardTypeIcon

Values
Enum Value Description

businessuser

check

checkfile

flag

fullStar

gift

globe

halfStar

heart

lightbulb

like

loading

signpost

star

stopwatch

tag

Example
"businessuser"

BackgroundJob

Fields
Field Name Description
createdAt - Date! The time the field was created.
description - String
errorMessage - String
id - ID! The ID of the Background Job.
repeatable - Boolean!
status - BackgroundJobStatus!
type - String!
Example
{
  "createdAt": "2007-12-03",
  "description": "abc123",
  "errorMessage": "abc123",
  "id": 4,
  "repeatable": true,
  "status": "complete",
  "type": "xyz789"
}

BackgroundJobStatus

Values
Enum Value Description

complete

failed

processing

queued

Example
"complete"

Badge

Fields
Field Name Description
asset - URL!
awardThreshold - Int!
awardType - AwardType
deleted - Boolean Returns true when the Badge is deleted.
id - ID! The ID of the Badge.
label - String!
Example
{
  "asset": "http://www.test.com/",
  "awardThreshold": 123,
  "awardType": AwardType,
  "deleted": true,
  "id": "4",
  "label": "abc123"
}

BadgeLeader

Fields
Field Name Description
rank - Int
total - Int
user - User
Example
{"rank": 123, "total": 123, "user": User}

BadgeLeaderboard

Fields
Field Name Description
awardType - AwardType
currentUserPosition - BadgeLeader
leaders - [BadgeLeader]
Example
{
  "awardType": AwardType,
  "currentUserPosition": BadgeLeader,
  "leaders": [BadgeLeader]
}

Block

Fields
Field Name Description
id - ID! The ID of the Block.
Example
{"id": 4}

Bookmark

Fields
Field Name Description
bookmarkFolder - BookmarkFolder!
course - Course! The ID of the Course.
createdAt - Date! The time the field was created.
deleted - Boolean! Returns true when the Bookmark is deleted.
id - ID! The ID of the Bookmark.
note - String
topic - Topic
topicId - ID The ID of the Topic.
user - User!
Example
{
  "bookmarkFolder": BookmarkFolder,
  "course": "course-1",
  "createdAt": "2007-12-03",
  "deleted": false,
  "id": "4",
  "note": "xyz789",
  "topic": Topic,
  "topicId": "4",
  "user": User
}

BookmarkFolder

Fields
Field Name Description
bookmarkCount - Int
bookmarks - [Bookmark!]
defaultFolder - Boolean
deleted - Boolean! Returns true when the Bookmark Folder is deleted.
externalResourceId - ID The ID of the External Resource.
id - ID! The ID of the Bookmark Folder.
name - String!
user - User!
Example
{
  "bookmarkCount": 987,
  "bookmarks": [Bookmark],
  "defaultFolder": true,
  "deleted": false,
  "externalResourceId": "4",
  "id": "4",
  "name": "xyz789",
  "user": User
}

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

Bundle

Fields
Field Name Description
annualPlanId - ID The ID of the Annual Plan.
annualPriceInCents - Int
id - ID! The ID of the Bundle.
name - String!
needShippingAddress - Boolean
planId - ID The ID of the Plan.
priceInCents - Int
purchasable - Boolean
slug - Slug!
taxable - Boolean
variations - [BundleVariation]
weight - Float
Example
{
  "annualPlanId": 4,
  "annualPriceInCents": 123,
  "id": 4,
  "name": "abc123",
  "needShippingAddress": false,
  "planId": "4",
  "priceInCents": 123,
  "purchasable": false,
  "slug": Slug,
  "taxable": false,
  "variations": [BundleVariation],
  "weight": 987.65
}

BundleVariation

Fields
Field Name Description
label - String
Example
{"label": "xyz789"}

CatalogCategory

Fields
Field Name Description
id - ID! The ID of the Catalog Category.
label - String!
slug - Slug!
subcategories - [CatalogSubcategory]
Example
{
  "id": 4,
  "label": "xyz789",
  "slug": Slug,
  "subcategories": [CatalogSubcategory]
}

CatalogContent

Fields
Field Name Description
contentItems - [Content!]
meta - CatalogMeta!
Example
{
  "contentItems": [Content],
  "meta": CatalogMeta
}

CatalogMeta

Description

Contains metadata about a requested Catalog.

Fields
Field Name Description
aggregations - [Aggregation!]
contentTypeFilterEnabled - Boolean!
contentTypes - [String!] Content Types requested in the Catalog.
debug - Boolean
displayAuthorsEnabled - Boolean!
displayBundle - Bundle
displayDescriptionOnCalendar - Boolean!
displayStartDateEnabled - Boolean!
displayTypeCalendarEnabled - Boolean!
displayTypeGridEnabled - Boolean!
displayTypeListEnabled - Boolean!
hasMore - Boolean!
isCurated - Boolean!
queryCustomFields - JSON!
resultsDisplayType - ContentItemDisplayType!
selectedSort - String! Use selectedSortColumn and selectedSortDirection
selectedSortColumn - SortColumn!
selectedSortDirection - SortDirection!
sortCourseStartDateEnabled - Boolean!
sortCreatedAtEnabled - Boolean!
sortPublishDateEnabled - Boolean!
sortRelevanceEnabled - Boolean!
sortTitleEnabled - Boolean!
sortUpdatedAtEnabled - Boolean!
tokenLabel - String
total - Int
Example
{
  "aggregations": [Aggregation],
  "contentTypeFilterEnabled": false,
  "contentTypes": ["courseGroups", "learningPaths"],
  "debug": false,
  "displayAuthorsEnabled": false,
  "displayBundle": Bundle,
  "displayDescriptionOnCalendar": true,
  "displayStartDateEnabled": false,
  "displayTypeCalendarEnabled": true,
  "displayTypeGridEnabled": false,
  "displayTypeListEnabled": false,
  "hasMore": false,
  "isCurated": true,
  "queryCustomFields": {},
  "resultsDisplayType": "calendar",
  "selectedSort": "abc123",
  "selectedSortColumn": "courseStartDate",
  "selectedSortDirection": "asc",
  "sortCourseStartDateEnabled": false,
  "sortCreatedAtEnabled": true,
  "sortPublishDateEnabled": false,
  "sortRelevanceEnabled": false,
  "sortTitleEnabled": true,
  "sortUpdatedAtEnabled": false,
  "tokenLabel": "xyz789",
  "total": 987
}

CatalogSettings

Fields
Field Name Description
boostRibbon - String
categories - [CatalogCategory!]
contentTypeFilterEnabled - Boolean
defaultQuery - String
defaultSort - String
displayAuthorsEnabled - Boolean
displayBundle - [Bundle!]
displayBundleId - ID The ID of the Display Bundle.
displayStartDateEnabled - Boolean
displayTypeCalendarEnabled - Boolean
displayTypeGridEnabled - Boolean
displayTypeListEnabled - Boolean
hidePastEvents - Boolean
id - ID! The ID of the Catalog Settings.
onlyDisplayAccessibleContent - Boolean
resultsDisplayType - ContentItemDisplayType!
sortCourseStartDateEnabled - Boolean
sortCreatedAtEnabled - Boolean
sortPublishDateEnabled - Boolean
sortRelevanceEnabled - Boolean
sortTitleEnabled - Boolean
sortUpdatedAtEnabled - Boolean
Example
{
  "boostRibbon": "xyz789",
  "categories": [CatalogCategory],
  "contentTypeFilterEnabled": true,
  "defaultQuery": "abc123",
  "defaultSort": "abc123",
  "displayAuthorsEnabled": false,
  "displayBundle": [Bundle],
  "displayBundleId": 4,
  "displayStartDateEnabled": true,
  "displayTypeCalendarEnabled": false,
  "displayTypeGridEnabled": false,
  "displayTypeListEnabled": true,
  "hidePastEvents": true,
  "id": "4",
  "onlyDisplayAccessibleContent": true,
  "resultsDisplayType": "calendar",
  "sortCourseStartDateEnabled": false,
  "sortCreatedAtEnabled": false,
  "sortPublishDateEnabled": false,
  "sortRelevanceEnabled": false,
  "sortTitleEnabled": false,
  "sortUpdatedAtEnabled": false
}

CatalogSubcategory

Fields
Field Name Description
description - String
id - ID! The ID of the Catalog Subcategory.
label - String!
query - String!
slug - Slug!
Example
{
  "description": "abc123",
  "id": "4",
  "label": "abc123",
  "query": "xyz789",
  "slug": Slug
}

Certificate

Fields
Field Name Description
certificateTemplate - CertificateTemplate
contentItem - Content
deleted - Boolean! Returns true when the Certificate is deleted.
didExpire - Boolean!
expirationDate - Date
externalResourceTitle - String
id - ID! The ID of the Certificate.
identifier - String
isExpired - Boolean!
isExternal - Boolean!
issuedAt - Date!
pdfAsset - AbsoluteOrRelativeURL
progressWasReset - Boolean!
recertificationDate - Date
resource - CertificateResource
resourceId - ID The ID of the Resource.
resourceType - CertificateResourceType
resourceTypeLabel - String
source - String
url - AbsoluteOrRelativeURL!
user - User!
Example
{
  "certificateTemplate": CertificateTemplate,
  "contentItem": Content,
  "deleted": true,
  "didExpire": false,
  "expirationDate": "2007-12-03",
  "externalResourceTitle": "xyz789",
  "id": "4",
  "identifier": "abc123",
  "isExpired": false,
  "isExternal": false,
  "issuedAt": "2007-12-03",
  "pdfAsset": AbsoluteOrRelativeURL,
  "progressWasReset": true,
  "recertificationDate": "2007-12-03",
  "resource": Course,
  "resourceId": 4,
  "resourceType": "course",
  "resourceTypeLabel": "abc123",
  "source": "abc123",
  "url": AbsoluteOrRelativeURL,
  "user": User
}

CertificateDateFormatType

Values
Enum Value Description

euroShort

DD-MM-YYYY (ex. 25-07-2019)

iso8601

YYYY-MM-DD (ex. 2019-07-25)

usLong

MMMM DD, YYYY (ex. July 25, 2019)

usShort

MM-DD-YYYY (ex. 07-25-2019)
Example
"euroShort"

CertificateField

Fields
Field Name Description
awardType - AwardType
awardTypeId - ID The ID of the Award Type.
customField - CustomField
customFieldSlug - Slug
dateFormat - CertificateDateFormatType
hasIdentifierPrefix - Boolean
id - ID! The ID of the Certificate Field.
identifierBodyLength - Int
identifierPrefix - String
includeOnExternalCertificate - Boolean!
includeOnTranscript - Boolean!
label - String!
sessionCustomContentFieldSlug - Slug
text - String
type - CertificateFieldType!
userCustomField - UserCustomField
userCustomFieldSlug - Slug
Example
{
  "awardType": AwardType,
  "awardTypeId": "4",
  "customField": CustomField,
  "customFieldSlug": Slug,
  "dateFormat": "euroShort",
  "hasIdentifierPrefix": true,
  "id": 4,
  "identifierBodyLength": 987,
  "identifierPrefix": "abc123",
  "includeOnExternalCertificate": false,
  "includeOnTranscript": true,
  "label": "abc123",
  "sessionCustomContentFieldSlug": Slug,
  "text": "abc123",
  "type": "awardLabel",
  "userCustomField": UserCustomField,
  "userCustomFieldSlug": Slug
}

CertificateFieldType

Values
Enum Value Description

awardLabel

Award Type

contentCompletionDate

Content Completion Date

contentFieldLabel

Custom Content Field

contentStartDate

Content Start Date

courseLabel

Content Title

dateLabel

Certificate Issued Date

expirationDateLabel

Certificate Expiration Date

identifier

Unique Identifier

learnerClientNameLabel

Learner Client Name

nameLabel

Learner Name

sessionCustomContentField

Session Custom Content Field

textLabel

Short Text

userFieldLabel

Custom Learner Field

userRef1Label

Learner Ref 1

userRef2Label

Learner Ref 2

userRef3Label

Learner Ref 3

userRef4Label

Learner Ref 4

userRef5Label

Learner Ref 5

userRef6Label

Learner Ref 6

userRef7Label

Learner Ref 7

userRef8Label

Learner Ref 8

userRef9Label

Learner Ref 9

userRef10Label

Learner Ref 10

viewCertificateLink

Link to View Certificate
Example
"awardLabel"

CertificateResource

Types
Union Types

Course

LearningPath

Example
Course

CertificateResourceType

Values
Enum Value Description

course

learningPath

Example
"course"

CertificateTemplate

Fields
Field Name Description
asset - URL
assetLibraryId - ID The ID of the Asset Library.
customCss - String
expirationDate - Date
expirationDays - Int
id - ID! The ID of the Certificate Template.
isExpired - Boolean!
labels - [CertificateTemplateLabel]
recertificationAction - CertificateTemplateRecertificationActionType
recertificationActionText - String
recertificationActionUrl - URL
recertificationAfterDays - Int
recertificationAutoReset - Boolean
recertificationInstructions - String
resource - CertificateTemplateResource!
resourceType - CertificateTemplateResourceType!
supplementalAssets - [URL!]
title - String
userCustomField - UserCustomField
userCustomFieldSlug - Slug
userCustomFieldValue - String
Example
{
  "asset": "http://www.test.com/",
  "assetLibraryId": 4,
  "customCss": "xyz789",
  "expirationDate": "2007-12-03",
  "expirationDays": 987,
  "id": "4",
  "isExpired": true,
  "labels": [CertificateTemplateLabel],
  "recertificationAction": "actionUrl",
  "recertificationActionText": "abc123",
  "recertificationActionUrl": "http://www.test.com/",
  "recertificationAfterDays": 987,
  "recertificationAutoReset": false,
  "recertificationInstructions": "xyz789",
  "resource": Course,
  "resourceType": "course",
  "supplementalAssets": [
    "http://www.test.com/"
  ],
  "title": "abc123",
  "userCustomField": UserCustomField,
  "userCustomFieldSlug": Slug,
  "userCustomFieldValue": "abc123"
}

CertificateTemplateLabel

Fields
Field Name Description
certificateField - CertificateField
certificateFieldId - ID!
fontColor - HexColor!
fontSize - Int!
id - ID! The ID of the Certificate Template Label.
textAlign - TextAlignment!
x - Int!
y - Int!
Example
{
  "certificateField": CertificateField,
  "certificateFieldId": 4,
  "fontColor": HexColor,
  "fontSize": 987,
  "id": 4,
  "textAlign": "center",
  "x": 987,
  "y": 987
}

CertificateTemplateRecertificationActionType

Values
Enum Value Description

actionUrl

Custom action text & URL

recertifyInSession

Recertify in current Session

resetProgress

Reset progress in Content
Example
"actionUrl"

CertificateTemplateResource

Types
Union Types

Course

LearningPath

Example
Course

CertificateTemplateResourceType

Values
Enum Value Description

course

learningPath

Example
"course"

CertificateUploadField

Fields
Input Field Description
awardAmount - Float
awardTypeId - ID
certificateFieldId - ID!
date - Date
type - CertificateFieldType!
value - String
Example
{
  "awardAmount": 123.45,
  "awardTypeId": "4",
  "certificateFieldId": 4,
  "date": "2007-12-03",
  "type": "awardLabel",
  "value": "abc123"
}

Client

Fields
Field Name Description
allocatedCredits - Float
appearance - AppearanceSettings
autoFilterForSelectedLanguage - Boolean
catalog - CatalogSettings
clientSubscriptionNeedsSetup - Boolean
courseIds - [ID!]
courseTagIds - [ID!]
courseTags - [Tag!]
courses - [Course!]
createdAt - Date The time the field was created.
currentBalance - Float
currentUserManagerAllocatedLicenseTree - [LicenseNode!]
customHost - String
dashboardLayoutId - ID The ID of the Dashboard Layout.
defaultLanguage - String
disabled - Boolean!
emailLayout - EmailLayoutSettings
enableBranding - Boolean!
enableCommunitiesSegmentation - Boolean
enableContentDetailPage - Boolean
enableCreditPurchasing - Boolean
enableCustomEmailSettings - Boolean
enableDiscussions - Boolean
enableEcommerce - Boolean!
enableGlobalLinks - Boolean!
enableLicenseDashboards - Boolean
enableNavLinks - Boolean!
enableOnboardingSurvey - Boolean!
enableRecommendationAssessment - Boolean
enableSegmentation - Boolean!
id - ID! The ID of the Client.
languageSelectorEnabled - Boolean
languages - [String!]
learningPathIds - [ID!]
learningPaths - [LearningPath!]
licenseEndDate - Date
licenseTree - [LicenseNode!]
licenses - [License!]
name - String!
notificationEmails - String
panorama - Boolean!
pendingJobs - [BackgroundJob]
primaryLicense - License
purchasableContentIds - [ID!]
purchasableTags - [Tag!]
redemptionLayoutId - ID The ID of the Redemption Layout.
schoolName - String
seatsAllocatedCount - Int
seatsLimit - Int
seatsUsedCount - Int
secretKey - String
sku - String
slug - Slug!
sso - SSOSettings
startingBalance - Float
tags - [Tag!]
updatedAt - Date The time the field was updated.
Example
{
  "allocatedCredits": 987.65,
  "appearance": AppearanceSettings,
  "autoFilterForSelectedLanguage": true,
  "catalog": CatalogSettings,
  "clientSubscriptionNeedsSetup": true,
  "courseIds": [4],
  "courseTagIds": [4],
  "courseTags": [Tag],
  "courses": [Course],
  "createdAt": "2007-12-03",
  "currentBalance": 123.45,
  "currentUserManagerAllocatedLicenseTree": [LicenseNode],
  "customHost": "abc123",
  "dashboardLayoutId": "4",
  "defaultLanguage": "abc123",
  "disabled": false,
  "emailLayout": EmailLayoutSettings,
  "enableBranding": false,
  "enableCommunitiesSegmentation": false,
  "enableContentDetailPage": false,
  "enableCreditPurchasing": true,
  "enableCustomEmailSettings": true,
  "enableDiscussions": false,
  "enableEcommerce": false,
  "enableGlobalLinks": false,
  "enableLicenseDashboards": true,
  "enableNavLinks": false,
  "enableOnboardingSurvey": false,
  "enableRecommendationAssessment": true,
  "enableSegmentation": true,
  "id": 4,
  "languageSelectorEnabled": true,
  "languages": ["abc123"],
  "learningPathIds": ["4"],
  "learningPaths": [LearningPath],
  "licenseEndDate": "2007-12-03",
  "licenseTree": [LicenseNode],
  "licenses": [License],
  "name": "xyz789",
  "notificationEmails": "xyz789",
  "panorama": true,
  "pendingJobs": [BackgroundJob],
  "primaryLicense": License,
  "purchasableContentIds": [4],
  "purchasableTags": [Tag],
  "redemptionLayoutId": 4,
  "schoolName": "xyz789",
  "seatsAllocatedCount": 987,
  "seatsLimit": 987,
  "seatsUsedCount": 123,
  "secretKey": "abc123",
  "sku": "abc123",
  "slug": Slug,
  "sso": SSOSettings,
  "startingBalance": 123.45,
  "tags": [Tag],
  "updatedAt": "2007-12-03"
}

Comment

Fields
Field Name Description
asset - URL
assetFileName - String
body - String
childComments - CommentsList
commentable - Commentable!
commentableId - ID!
commentableType - CommentableType!
createdAt - Date The time the field was created.
id - ID! The ID of the Comment.
likesCount - Int
notificationsEnabled - Boolean!
parentComment - Comment
updatedAt - Date The time the field was updated.
user - User!
userLikeId - ID The ID of the User Like.
videoAsset - ID The ID of the Video Asset.
Example
{
  "asset": "http://www.test.com/",
  "assetFileName": "xyz789",
  "body": "abc123",
  "childComments": CommentsList,
  "commentable": Thread,
  "commentableId": 4,
  "commentableType": "assignment",
  "createdAt": "2007-12-03",
  "id": 4,
  "likesCount": 987,
  "notificationsEnabled": false,
  "parentComment": Comment,
  "updatedAt": "2007-12-03",
  "user": User,
  "userLikeId": "4",
  "videoAsset": 4
}

Commentable

Types
Union Types

Thread

Topic

Example
Thread

CommentableType

Values
Enum Value Description

assignment

assignmentSubmission

discussionBoard

thread

widgetThread

Example
"assignment"

CommentsList

Fields
Field Name Description
comments - [Comment!]
pageInfo - PageInfo!
Example
{
  "comments": [Comment],
  "pageInfo": PageInfo
}

Company

Fields
Field Name Description
appearanceSettings - AppearanceSettings
catalogBlock - Block
catalogVisibilityEmails - [String!]
id - ID! The ID of the Company.
micrositeFooter - MicrositeBlock
micrositeHeader - MicrositeBlock
name - String
organization - Organization
subdomain - String
Example
{
  "appearanceSettings": AppearanceSettings,
  "catalogBlock": Block,
  "catalogVisibilityEmails": ["xyz789"],
  "id": "4",
  "micrositeFooter": MicrositeBlock,
  "micrositeHeader": MicrositeBlock,
  "name": "xyz789",
  "organization": Organization,
  "subdomain": "xyz789"
}

CompanyDetails

Fields
Field Name Description
name - String
settings - AppearanceSettings
subdomain - String
Example
{
  "name": "abc123",
  "settings": AppearanceSettings,
  "subdomain": "xyz789"
}

CompetencyAssessment

Fields
Field Name Description
continueAfterTimerExpires - Boolean!
createdAt - Date! The time the field was created.
failMessage - String
id - ID! The ID of the Competency Assessment.
isGraded - Boolean!
minimumPassingPercentage - Int
passMessage - String
questions - [CompetencyAssessmentQuestion!]
resourceItems - [CompetencyAssessmentResource!]
resources - [Resource!]
sku - String
timeLimitInSeconds - Int
title - String!
updatedAt - Date! The time the field was updated.
Example
{
  "continueAfterTimerExpires": true,
  "createdAt": "2007-12-03",
  "failMessage": "xyz789",
  "id": "4",
  "isGraded": true,
  "minimumPassingPercentage": 123,
  "passMessage": "xyz789",
  "questions": [CompetencyAssessmentQuestion],
  "resourceItems": [Layout],
  "resources": [Resource],
  "sku": "abc123",
  "timeLimitInSeconds": 123,
  "title": "xyz789",
  "updatedAt": "2007-12-03"
}

CompetencyAssessmentQuestion

Fields
Field Name Description
body - String!
choices - JSON
id - ID! The ID of the Competency Assessment Question.
mustSelectAllCorrectChoices - Boolean!
type - CompetencyAssessmentQuestionType!
Example
{
  "body": "xyz789",
  "choices": {},
  "id": "4",
  "mustSelectAllCorrectChoices": true,
  "type": "dropDown"
}

CompetencyAssessmentQuestionType

Values
Enum Value Description

dropDown

multipleChoice

selectBoxes

Example
"dropDown"

CompetencyAssessmentResource

Types
Union Types

Layout

LearningPath

Example
Layout

Content

Fields
Field Name Description
altDescriptionBody - String
alternativePricingRef - Int
alternativePricingType - AlternativePricingType
asset - String
authors - [String]
authorsAndInstructors - [String!]
availabilityStatus - String
bulkPurchasingEnabled - Boolean
canAddToQueue - Boolean
contentTypeAssetAspectRatio - String
contentTypeLabel - String
courseEndDate - Date
courseGracePeriodEnded - Boolean!
courseGroup - String
coursePresold - Boolean!
courseStartDate - Date
createdAt - Date The time the field was created.
currentUserMayReschedule - Boolean!
currentUserUnmetCoursePrerequisites - [ID]
currentUserUnmetLearningPathPrerequisites - [ID]
customFields - JSON
description - String
displayCourse - ID The ID of the Display Course.
displayCourseSlug - Slug
displayDate - Date
embeddedEnabled - Boolean
enrollmentCount - Int
expiresAt - Date
hasChildren - Boolean!
hideCourseDescription - Boolean!
id - ID! The ID of the Content.
isActive - Boolean!
kind - ContentKind
language - String
location - Location
meetingStartDate - Date
metaDescription - String
metaTitle - String
priceInCents - Int
publishDate - Date
rating - Int
ribbon - Ribbon
seatsLimit - Int
sessionTitle - String
sku - String
slug - Slug!
source - String
status - Status
suggestedRetailPriceInCents - Int
tags - [Tag]
timeZone - String
title - String
updatedAt - Date The time the field was updated.
url - AbsoluteOrRelativeURL
waitlistCount - Int
waitlistingEnabled - Boolean!
waitlistingTriggered - Boolean!
Example
{
  "altDescriptionBody": "xyz789",
  "alternativePricingRef": 987,
  "alternativePricingType": "membership",
  "asset": "abc123",
  "authors": ["xyz789"],
  "authorsAndInstructors": ["abc123"],
  "availabilityStatus": "abc123",
  "bulkPurchasingEnabled": true,
  "canAddToQueue": true,
  "contentTypeAssetAspectRatio": "xyz789",
  "contentTypeLabel": "abc123",
  "courseEndDate": "2007-12-03",
  "courseGracePeriodEnded": true,
  "courseGroup": "courseGroup-1",
  "coursePresold": false,
  "courseStartDate": "2007-12-03",
  "createdAt": "2007-12-03",
  "currentUserMayReschedule": true,
  "currentUserUnmetCoursePrerequisites": [
    "4"
  ],
  "currentUserUnmetLearningPathPrerequisites": [4],
  "customFields": {},
  "description": "xyz789",
  "displayCourse": 4,
  "displayCourseSlug": Slug,
  "displayDate": "2007-12-03",
  "embeddedEnabled": false,
  "enrollmentCount": 987,
  "expiresAt": "2007-12-03",
  "hasChildren": true,
  "hideCourseDescription": true,
  "id": "4",
  "isActive": false,
  "kind": "article",
  "language": "xyz789",
  "location": Location,
  "meetingStartDate": "2007-12-03",
  "metaDescription": "xyz789",
  "metaTitle": "xyz789",
  "priceInCents": 123,
  "publishDate": "2007-12-03",
  "rating": 987,
  "ribbon": Ribbon,
  "seatsLimit": 123,
  "sessionTitle": "xyz789",
  "sku": "abc123",
  "slug": Slug,
  "source": "xyz789",
  "status": "archived",
  "suggestedRetailPriceInCents": 123,
  "tags": [Tag],
  "timeZone": "abc123",
  "title": "xyz789",
  "updatedAt": "2007-12-03",
  "url": AbsoluteOrRelativeURL,
  "waitlistCount": 987,
  "waitlistingEnabled": true,
  "waitlistingTriggered": true
}

ContentGroup

Fields
Field Name Description
count - Int!
kind - ContentGroupKind!
Example
{"count": 987, "kind": "archivedContentItems"}

ContentGroupKind

Values
Enum Value Description

archivedContentItems

bookmarkFolders

certificates

completedItems

contentItems

eventItems

learningPaths

waitlistedCourses

Example
"archivedContentItems"

ContentItemDisplayType

Values
Enum Value Description

calendar

grid

list

Example
"calendar"

ContentKind

Values
Enum Value Description

article

bundle

course

courseGroup

discountGroup

inPersonEvent

inPersonEventCourse

learningPath

microCourse

pickableGroup

product

sellable

shareableContentObject

video

webinar

webinarCourse

xApiObject

Example
"article"

ContentOrTopicEnum

Values
Enum Value Description

course

topic

Example
"course"

ContentType

Fields
Field Name Description
assetAspectRatio - String
label - String
Example
{
  "assetAspectRatio": "xyz789",
  "label": "abc123"
}

Course

Fields
Field Name Description
accessDays - Int
alternativePricingRef - Int
alternativePricingType - AlternativePricingType
appearanceBlock - ID The ID of the Appearance Block.
appearanceHash - String