AWorld Lab API Reference
API ReferenceApp API (Consumer)Dashboard API (Admin)
API ReferenceApp API (Consumer)Dashboard API (Admin)
  1. Learning Groups
  • AI
    • Generate an image with AI
    • Generate learning path
    • Translate learning path
    • Translate content
    • Get AI image generation status
    • Get generation status
    • Cancel generation
    • Continue AI generation
  • Activities
    • Tags
      • List activity tag assignments
      • Create multiple activity tag assignments
      • Update multiple activity tag assignments
      • Delete multiple activity tag assignments
      • Get activity tag assignment
      • Create activity tag assignment
      • Update activity tag assignment
      • Delete activity tag assignment
    • Translations
      • List activity translations
    • List activities
    • Create activity
    • Get activity
    • Update activity
    • Archive activity
    • Publish activity
    • Unarchive activity
  • Analytics
    • Get content analytics
    • Get economy analytics
    • Get engagement analytics
    • Get gamification analytics
    • Get learning analytics
    • Get analytics overview
    • Get quiz analytics
  • BadgeConfigurations
    • Tags
      • Create multiple badge configuration tag assignments
      • Delete multiple badge configuration tag assignments
      • List badge configuration tag assignments
      • Update multiple badge configuration tag assignments
      • Create badge configuration tag assignment
      • Delete badge configuration tag assignment
      • Get badge configuration tag assignment
      • Update badge configuration tag assignment
    • Translations
      • List badge configuration translations
    • Create badge configuration
    • List badge configurations
    • Get badge configuration
    • Update badge configuration
    • Archive badge configuration
    • Publish badge configuration
    • Unarchive badge configuration
  • ContentLayouts
    • Create content layout
    • List content layouts
    • Get content layout
    • Update content layout
    • Archive content layout
    • Clone content layout
    • Publish content layout
    • Unarchive content layout
  • ContentThemes
    • List content themes
    • Create content theme
    • Get content theme by ID
    • Update content theme
    • Archive a content theme
    • Clone content theme from catalog
    • Publish a content theme
    • Unarchive a content theme
  • EmailTemplates
    • List email templates
    • Create email template
    • Get email template
    • Update email template
    • Publish email template
  • Learning Groups
    • Tags
      • List learning group tag assignments
      • Create multiple learning group tag assignments
      • Update multiple learning group tag assignments
      • Delete multiple learning group tag assignments
      • Get learning group tag assignment
      • Create learning group tag assignment
      • Update learning group tag assignment
      • Delete learning group tag assignment
    • Translations
      • List learning group translations
    • List learning groups
      GET
    • Create learning group
      POST
    • Get learning group
      GET
    • Update learning group
      PUT
    • Archive learning group
      POST
    • Publish learning group
      POST
    • Unarchive learning group
      POST
  • Learning Paths
    • Assignments
      • List learning path assignments
    • Items
      • List learning group items
      • List learning path items
    • Tags
      • List learning path tag assignments
      • Create multiple learning path tag assignments
      • Update multiple learning path tag assignments
      • Delete multiple learning path tag assignments
      • Get learning path tag assignment
      • Create learning path tag assignment
      • Update learning path tag assignment
      • Delete learning path tag assignment
    • Translations
      • List learning path translations
    • List learning paths
    • Create learning path
    • Get learning path
    • Update learning path
    • Archive learning path
    • Clone learning path
    • Publish learning path
    • Unarchive learning path
  • LearningPathAssignments
    • List learning path assignments
    • Create learning path assignment
    • Delete learning path assignments (bulk)
    • Get learning path assignment
    • Delete a learning path assignment
  • LearningPathRules
    • List learning path rules
    • Create learning path rule
    • Get learning path rule
    • Update learning path rule
    • Publish learning path rule
  • Media
    • Tags
      • List media tag assignments
      • Create multiple media tag assignments
      • Update multiple media tag assignments
      • Delete multiple media tag assignments
      • Get media tag assignment
      • Create media tag assignment
      • Update media tag assignment
      • Delete media tag assignment
    • Translations
      • List media translations
    • List media files
    • Get media file by ID
    • Update media file metadata
    • Delete media file
    • Get presigned upload URL
  • MissionConfigurations
    • Tags
      • List mission configuration tag assignments
      • Create multiple mission configuration tag assignments
      • Update multiple mission configuration tag assignments
      • Delete multiple mission configuration tag assignments
      • Get mission configuration tag assignment
      • Create mission configuration tag assignment
      • Update mission configuration tag assignment
      • Delete mission configuration tag assignment
    • Translations
      • List mission configuration translations
    • List mission configurations
    • Create mission configuration
    • Get mission configuration
    • Update mission configuration
    • Archive mission configuration
    • Publish mission configuration
    • Unarchive mission configuration
  • MissionRules
    • Tags
      • List mission rule tag assignments
      • Create multiple mission rule tag assignments
      • Update multiple mission rule tag assignments
      • Delete multiple mission rule tag assignments
      • Get mission rule tag assignment
      • Create mission rule tag assignment
      • Update mission rule tag assignment
      • Delete mission rule tag assignment
    • Translations
      • List mission rule translations
    • List mission rules
    • Create mission rule
    • Get mission rule
    • Update mission rule
    • Archive mission rule
    • Publish mission rule
    • Unarchive mission rule
  • Missions
    • Create mission
  • Mobility
    • List mobility activations
    • Create or update mobility activation
    • List mobility milestones
    • List mobility trackings
    • Get mobility milestone
    • Get MotionTag status
    • Get MotionTag token
    • Redeem mobility milestone
  • Quizzes
    • Tags
      • Create multiple quiz tag assignments
      • Delete multiple quiz tag assignments
      • List quiz tag assignments
      • Update multiple quiz tag assignments
      • Create quiz tag assignment
      • Delete quiz tag assignment
      • Get quiz tag assignment
      • Update quiz tag assignment
    • Create quiz
    • List quizzes
    • Get quiz
    • Update quiz
    • Archive quiz
    • Publish quiz
    • Unarchive quiz
  • RewardRules
    • Translations
      • List reward rule translations
    • List reward rules
    • Create reward rule
    • Get reward rule
    • Update reward rule
    • Archive reward rule
    • Publish reward rule
    • Unarchive reward rule
  • Runtime Leaderboards
    • List runtime leaderboards
    • Create runtime leaderboard
    • Get runtime leaderboard
    • Update runtime leaderboard
  • RuntimeLeaderboardConfigurations
    • List runtime leaderboard configurations
    • Create runtime leaderboard configuration
    • Get runtime leaderboard configuration
    • Update runtime leaderboard configuration
    • Create runtime leaderboard instance
    • Publish runtime leaderboard configuration
    • List runtime leaderboard configuration translations
  • Slides
    • Tags
      • List slide tag assignments
      • Create multiple slide tag assignments
      • Update multiple slide tag assignments
      • Delete multiple slide tag assignments
      • Get slide tag assignment
      • Create slide tag assignment
      • Update slide tag assignment
      • Delete slide tag assignment
    • Translations
      • List slide translations
    • List slides
    • Create slide
    • Get slide
    • Update slide
    • Archive slide
    • Publish slide
    • Unarchive slide
  • StreakConfigurations
    • Tags
      • Create multiple streak configuration tag assignments
      • Delete multiple streak configuration tag assignments
      • List streak configuration tag assignments
      • Update multiple streak configuration tag assignments
      • Create streak configuration tag assignment
      • Delete streak configuration tag assignment
      • Get streak configuration tag assignment
      • Update streak configuration tag assignment
    • Translations
      • List streak configuration translations
    • Create streak configuration
    • List streak configurations
    • Get streak configuration
    • Update streak configuration
    • Archive streak configuration
    • Publish streak configuration
    • Unarchive streak configuration
  • StreakRules
    • Tags
      • Create multiple streak rule tag assignments
      • Delete multiple streak rule tag assignments
      • List streak rule tag assignments
      • Update multiple streak rule tag assignments
      • Create streak rule tag assignment
      • Delete streak rule tag assignment
      • Get streak rule tag assignment
      • Update streak rule tag assignment
    • Translations
      • List streak rule translations
    • Create streak rule
    • List streak rules
    • Get streak rule
    • Update streak rule
    • Archive streak rule
    • Publish streak rule
    • Unarchive streak rule
  • TagRules
    • Translations
      • List tag rule translations
    • List tag rules
    • Create tag rule
    • Get tag rule by ID
    • Update tag rule
    • Archive tag rule
    • Publish tag rule
    • Unarchive tag rule
  • Tags
    • List tags
    • Create tag
    • Get tag
    • Update tag
    • Archive tag
    • Publish tag
    • List tag translations
    • Unarchive tag
  • Users
    • Tags
      • List user tag assignments
      • Create multiple user tag assignments
      • Update multiple user tag assignments
      • Delete multiple user tag assignments
      • Get user tag assignment
      • Create user tag assignment
      • Update user tag assignment
      • Delete user tag assignment
    • List users
    • Create user
    • Get current user principal
    • Get user by ID
    • Update user by ID
    • Delete (anonymise) user by ID
    • Get current user
    • Get user by external ID
    • Get current user permissions
    • Get current user referral code
  • VirtualCurrencies
    • List virtual currencies
    • Create virtual currency
    • Get virtual currency
    • Update virtual currency
    • Archive virtual currency
    • Publish virtual currency
    • List virtual currency translations
    • Unarchive virtual currency
  • VirtualTransactions
    • Create virtual transaction
  • Workspace
    • Get workspace
  • WorkspaceConfiguration
    • Get workspace configuration
    • Update workspace configuration
    • Delete workspace configuration
    • Publish workspace configuration
  • ContentLayoutTagAssignments
    • Create multiple content layout tag assignments
    • Delete multiple content layout tag assignments
    • List content layout tag assignments
    • Update multiple content layout tag assignments
    • Create content layout tag assignment
    • Delete content layout tag assignment
    • Get content layout tag assignment
    • Update content layout tag assignment
  • ContentLayoutTranslations
    • List content layout translations
  • ContentThemeTagAssignments
    • List content theme tag assignments
    • Create multiple content theme tag assignments
    • Update multiple content theme tag assignments
    • Delete multiple content theme tag assignments
    • Get content theme tag assignment
    • Create content theme tag assignment
    • Update content theme tag assignment
    • Delete content theme tag assignment
  • ContentThemeTranslations
    • List content theme translations
  • Invitations
    • List invitations
    • Create invitation
    • Get invitation by ID
    • Revoke invitation
  • LearningGroups
    • Generate learning group
  • QuizTranslations
    • List quiz translations
  • UserPrincipals
    • Get user principal
  • WorkspaceCodes
    • List workspace codes
    • Create workspace code
    • Get workspace code by ID
    • Revoke workspace code
    • Get workspace code by code string
  • WorkspaceEntitlement
    • Get workspace entitlement
  • WorkspaceSeat
    • Get workspace seat usage
  • WorkspaceSeatLogs
    • List workspace seat logs
  • LearningPaths
    • Batch update entity translations
  • SurveyTagAssignments
    • Create multiple survey tag assignments
    • Delete multiple survey tag assignments
    • List survey tag assignments
    • Update multiple survey tag assignments
    • Create survey tag assignment
    • Delete survey tag assignment
    • Get survey tag assignment
    • Update survey tag assignment
  • Surveys
    • Create survey
    • List surveys
    • Get survey
    • Update survey
    • Archive survey
    • Publish survey
    • List survey logs
    • Unarchive survey
    • Get survey log
  • Schemas
    • ActivityTranslation
    • ActivityWithResolvedFields
    • ArchiveBadgeConfigurationResponse
    • ArchiveActivityResponse
    • ArchiveContentLayoutResponse
    • ArchiveContentThemeResponse
    • ArchiveLearningGroupResponse
    • ArchiveLearningPathResponse
    • ArchiveQuizResponse
    • ArchiveSlideResponse
    • ArchiveMissionConfigurationResponse
    • ArchiveTagResponse
    • ArchiveMissionRuleResponse
    • CancelGenerationResponse
    • CloneContentLayoutResponse
    • ArchiveRewardRuleResponse
    • CloneContentThemeResponse
    • CloneLearningPathResponse
    • ArchiveStreakConfigurationResponse
    • ContentAnalyticsResponse
    • ArchiveStreakRuleResponse
    • ContinueGenerationResponse
    • ArchiveSurveyResponse
    • CreateActivityResponse
    • ArchiveTagRuleResponse
    • CreateActivityTagAssignmentResponse
    • ArchiveVirtualCurrencyResponse
    • CreateActivityTagAssignmentsResponse
    • BatchTranslationResponse
    • CreateBadgeConfigurationResponse
    • CreateBadgeConfigurationTagAssignmentResponse
    • CreateBadgeConfigurationTagAssignmentsResponse
    • CreateContentLayoutResponse
    • CreateContentLayoutTagAssignmentResponse
    • CreateContentLayoutTagAssignmentsResponse
    • CreateContentThemeResponse
    • CreateContentThemeTagAssignmentResponse
    • CreateContentThemeTagAssignmentsResponse
    • CreateEmailTemplateResponse
    • CreateLearningGroupResponse
    • CreateLearningGroupTagAssignmentResponse
    • CreateLearningGroupTagAssignmentsResponse
    • CreateLearningPathAssignmentResponse
    • CreateLearningPathResponse
    • CreateLearningPathRuleResponse
    • CreateLearningPathTagAssignmentResponse
    • CreateLearningPathTagAssignmentsResponse
    • CreateMediaTagAssignmentResponse
    • CreateInvitationResponse
    • CreateMediaTagAssignmentsResponse
    • CreateMissionConfigurationResponse
    • CreateMissionConfigurationTagAssignmentResponse
    • CreateMissionConfigurationTagAssignmentsResponse
    • CreateMissionResponse
    • CreateMissionRuleResponse
    • CreateMissionRuleTagAssignmentResponse
    • CreateMissionRuleTagAssignmentsResponse
    • CreateMobilityActivationResponse
    • CreateQuizResponse
    • CreateQuizTagAssignmentResponse
    • CreateQuizTagAssignmentsResponse
    • CreateRewardRuleResponse
    • CreateRuntimeLeaderboardConfigurationResponse
    • CreateRuntimeLeaderboardInstanceResponse
    • CreateRuntimeLeaderboardResponse
    • CreateSlideResponse
    • CreateSlideTagAssignmentResponse
    • CreateSlideTagAssignmentsResponse
    • CreateStreakConfigurationResponse
    • CreateStreakConfigurationTagAssignmentResponse
    • CreateStreakConfigurationTagAssignmentsResponse
    • CreateStreakRuleResponse
    • CreateTagResponse
    • CreateTagRuleResponse
    • CreateUserResponse
    • CreateVirtualCurrencyResponse
    • CreateVirtualTransactionResponse
    • CreateStreakRuleTagAssignmentResponse
    • DeleteLearningGroupTagAssignmentResponse
    • CreateStreakRuleTagAssignmentsResponse
    • DeleteLearningGroupTagAssignmentsResponse
    • DeleteLearningPathAssignmentResponse
    • DeleteLearningPathAssignmentsResponse
    • CreateSurveyResponse
    • DeleteLearningPathTagAssignmentResponse
    • CreateUserTagAssignmentResponse
    • CreateSurveyTagAssignmentResponse
    • DeleteLearningPathTagAssignmentsResponse
    • CreateUserTagAssignmentsResponse
    • CreateSurveyTagAssignmentsResponse
    • DeleteMediaResponse
    • DeleteMediaTagAssignmentResponse
    • DeleteMediaTagAssignmentsResponse
    • CreateWorkspaceCodeResponse
    • DeleteMissionConfigurationTagAssignmentResponse
    • DeleteActivityTagAssignmentResponse
    • DeleteMissionConfigurationTagAssignmentsResponse
    • DeleteActivityTagAssignmentsResponse
    • DeleteMissionRuleTagAssignmentResponse
    • DeleteBadgeConfigurationTagAssignmentResponse
    • DeleteMissionRuleTagAssignmentsResponse
    • DeleteBadgeConfigurationTagAssignmentsResponse
    • DeleteQuizTagAssignmentResponse
    • DeleteContentLayoutTagAssignmentResponse
    • DeleteQuizTagAssignmentsResponse
    • DeleteContentLayoutTagAssignmentsResponse
    • DeleteSlideTagAssignmentResponse
    • DeleteContentThemeTagAssignmentResponse
    • DeleteSlideTagAssignmentsResponse
    • DeleteContentThemeTagAssignmentsResponse
    • DeleteStreakConfigurationTagAssignmentResponse
    • DeleteStreakConfigurationTagAssignmentsResponse
    • DeleteUserResponse
    • DeleteWorkspaceConfigurationResponse
    • EconomyAnalyticsResponse
    • EmailTemplateTranslation
    • EngagementAnalyticsResponse
    • GamificationAnalyticsResponse
    • GenerateLearningPathResponse
    • GetActivityResponse
    • GetActivityTagAssignmentResponse
    • GetBadgeConfigurationResponse
    • GetBadgeConfigurationTagAssignmentResponse
    • GetContentLayoutResponse
    • GetContentLayoutTagAssignmentResponse
    • GetContentThemeResponse
    • GetContentThemeTagAssignmentResponse
    • GetCurrentUserPrincipalResponse
    • DeleteStreakRuleTagAssignmentResponse
    • GetCurrentUserResponse
    • DeleteStreakRuleTagAssignmentsResponse
    • GetEmailTemplateResponse
    • GetGenerationStatusResponse
    • DeleteUserTagAssignmentResponse
    • GetLearningGroupResponse
    • DeleteUserTagAssignmentsResponse
    • GetLearningGroupTagAssignmentResponse
    • GetLearningPathAssignmentResponse
    • GetLearningPathResponse
    • EmailTemplate
    • DeleteSurveyTagAssignmentResponse
    • GetLearningPathRuleResponse
    • DeleteSurveyTagAssignmentsResponse
    • GetLearningPathTagAssignmentResponse
    • GetMediaResponse
    • GetMediaTagAssignmentResponse
    • GenerateImageResponse
    • GetMissionConfigurationResponse
    • GenerateLearningGroupResponse
    • GetMissionConfigurationTagAssignmentResponse
    • GetMissionRuleResponse
    • GetMissionRuleTagAssignmentResponse
    • GetMobilityMilestoneResponse
    • GetMotionTagStatusResponse
    • GetMotionTagTokenResponse
    • GetQuizResponse
    • GetQuizTagAssignmentResponse
    • GetRewardRuleResponse
    • GetRuntimeLeaderboardConfigurationResponse
    • GetCurrentUserPermissionsResponse
    • GetRuntimeLeaderboardResponse
    • GetSlideResponse
    • GetCurrentUserReferralCodeResponse
    • GetSlideTagAssignmentResponse
    • GetStreakConfigurationResponse
    • GetInvitationResponse
    • GetStreakConfigurationTagAssignmentResponse
    • GetStreakRuleResponse
    • GetStreakRuleTagAssignmentResponse
    • GetTagResponse
    • GetTagRuleResponse
    • GetUploadUrlResponse
    • GetUserByExternalIdResponse
    • GetUserResponse
    • GetUserTagAssignmentResponse
    • GetVirtualCurrencyResponse
    • GetWorkspaceConfigurationResponse
    • GetWorkspaceResponse
    • JsonLogicExpression
    • Lang
    • LearningAnalyticsResponse
    • ListActivitiesResponse
    • ListActivityTagAssignmentsResponse
    • ListActivityTranslationsResponse
    • ListBadgeConfigurationsResponse
    • ListBadgeConfigurationTagAssignmentsResponse
    • ListBadgeConfigurationTranslationsResponse
    • ListContentLayoutsResponse
    • ListContentLayoutTagAssignmentsResponse
    • ListContentLayoutTranslationsResponse
    • ListContentThemesResponse
    • ListContentThemeTagAssignmentsResponse
    • ListContentThemeTranslationsResponse
    • ListEmailTemplatesResponse
    • ListLearningGroupItemsResponse
    • ListLearningGroupsResponse
    • ListLearningGroupTagAssignmentsResponse
    • GetUserPrincipalResponse
    • ListLearningGroupTranslationsResponse
    • ListLearningPathAssignmentsByLPResponse
    • ListLearningPathAssignmentsResponse
    • GetSurveyLogResponse
    • ListLearningPathItemsResponse
    • GetWorkspaceCodeByCodeResponse
    • GetSurveyResponse
    • ListLearningPathRulesResponse
    • GetWorkspaceCodeResponse
    • GetSurveyTagAssignmentResponse
    • ListLearningPathsResponse
    • ListLearningPathTagAssignmentsResponse
    • GetWorkspaceEntitlementResponse
    • ListLearningPathTranslationsResponse
    • ListMediaResponse
    • GetWorkspaceSeatResponse
    • ListMediaTagAssignmentsResponse
    • ImageGenerationStatusResponse
    • ListMediaTranslationsResponse
    • Invitation
    • ListMissionConfigurationsResponse
    • ListMissionConfigurationTagAssignmentsResponse
    • ListMissionConfigurationTranslationsResponse
    • ListMissionRulesResponse
    • ListMissionRuleTagAssignmentsResponse
    • ListMissionRuleTranslationsResponse
    • ListMobilityActivationsResponse
    • ListMobilityMilestonesResponse
    • ListMobilityTrackingsResponse
    • ListQuizTagAssignmentsResponse
    • ListQuizTranslationsResponse
    • ListQuizzesResponse
    • ListRewardRulesResponse
    • ListRewardRuleTranslationsResponse
    • ListRuntimeLeaderboardConfigurationsResponse
    • ListRuntimeLeaderboardConfigurationTranslationsResponse
    • ListRuntimeLeaderboardsResponse
    • ListInvitationsResponse
    • ListSlidesResponse
    • ListSlideTagAssignmentsResponse
    • ListSlideTranslationsResponse
    • ListStreakConfigurationsResponse
    • ListStreakConfigurationTagAssignmentsResponse
    • ListStreakConfigurationTranslationsResponse
    • ListStreakRulesResponse
    • ListStreakRuleTranslationResponse
    • ListTagRulesResponse
    • ListTagRuleTranslationsResponse
    • ListTagsResponse
    • ListTagTranslationsResponse
    • ListUsersResponse
    • ListVirtualCurrenciesResponse
    • ListVirtualCurrencyTranslationResponse
    • MediaTranslation
    • MediaWithResolvedFields
    • OverviewAnalyticsResponse
    • PublishActivityResponse
    • PublishBadgeConfigurationResponse
    • PublishContentLayoutResponse
    • PublishContentThemeResponse
    • PublishEmailTemplateResponse
    • PublishLearningGroupResponse
    • PublishLearningPathResponse
    • PublishLearningPathRuleResponse
    • PublishMissionConfigurationResponse
    • PublishMissionRuleResponse
    • PublishQuizResponse
    • PublishRewardRuleResponse
    • PublishSlideResponse
    • PublishStreakConfigurationResponse
    • PublishStreakRuleResponse
    • PublishTagResponse
    • PublishTagRuleResponse
    • ListStreakRuleTagAssignmentsResponse
    • PublishVirtualCurrencyResponse
    • PublishWorkspaceConfigurationResponse
    • QuizAnalyticsResponse
    • RedeemMobilityMilestoneResponse
    • RewardRuleWithResolvedFields
    • SourceRegion
    • ListUserTagAssignmentsResponse
    • Timezone
    • TranslateResponse
    • ListWorkspaceCodesResponse
    • UnarchiveBadgeConfigurationResponse
    • ListWorkspaceSeatLogsResponse
    • UnarchiveContentLayoutResponse
    • ListSurveyLogsResponse
    • UnarchiveContentThemeResponse
    • ListSurveysResponse
    • UnarchiveLearningGroupResponse
    • ListSurveyTagAssignmentsResponse
    • UnarchiveLearningPathResponse
    • UnarchiveQuizResponse
    • UnarchiveSlideResponse
    • UnarchiveTagResponse
    • UpdateActivityResponse
    • UpdateActivityTagAssignmentResponse
    • UpdateActivityTagAssignmentsResponse
    • UpdateBadgeConfigurationResponse
    • UpdateBadgeConfigurationTagAssignmentResponse
    • UpdateBadgeConfigurationTagAssignmentsResponse
    • UpdateContentLayoutResponse
    • UpdateContentLayoutTagAssignmentResponse
    • UpdateContentLayoutTagAssignmentsResponse
    • PublishRuntimeLeaderboardConfigurationResponse
    • UpdateContentThemeResponse
    • UpdateContentThemeTagAssignmentResponse
    • UpdateContentThemeTagAssignmentsResponse
    • UpdateEmailTemplateResponse
    • UpdateLearningGroupResponse
    • UpdateLearningGroupTagAssignmentResponse
    • UpdateLearningGroupTagAssignmentsResponse
    • UpdateLearningPathResponse
    • RevokeInvitationResponse
    • UpdateLearningPathRuleResponse
    • RevokeWorkspaceCodeResponse
    • UpdateLearningPathTagAssignmentResponse
    • UpdateLearningPathTagAssignmentsResponse
    • UpdateMediaResponse
    • UpdateMediaTagAssignmentResponse
    • UpdateMediaTagAssignmentsResponse
    • UnarchiveActivityResponse
    • TranslateLearningPathResponse
    • UpdateMissionConfigurationResponse
    • PublishSurveyResponse
    • UpdateMissionConfigurationTagAssignmentResponse
    • UpdateMissionConfigurationTagAssignmentsResponse
    • UpdateMissionRuleResponse
    • UpdateMissionRuleTagAssignmentResponse
    • UpdateMissionRuleTagAssignmentsResponse
    • UnarchiveMissionConfigurationResponse
    • UpdateQuizResponse
    • UnarchiveMissionRuleResponse
    • UpdateQuizTagAssignmentResponse
    • UpdateQuizTagAssignmentsResponse
    • UnarchiveRewardRuleResponse
    • UpdateRewardRuleResponse
    • UnarchiveStreakConfigurationResponse
    • UpdateRuntimeLeaderboardConfigurationResponse
    • UnarchiveStreakRuleResponse
    • UpdateRuntimeLeaderboardResponse
    • UpdateSlideResponse
    • UnarchiveTagRuleResponse
    • UpdateSlideTagAssignmentResponse
    • UnarchiveVirtualCurrencyResponse
    • UpdateSlideTagAssignmentsResponse
    • UpdateStreakConfigurationResponse
    • UpdateStreakConfigurationTagAssignmentResponse
    • UpdateStreakConfigurationTagAssignmentsResponse
    • UpdateStreakRuleResponse
    • UpdateStreakRuleTagAssignmentResponse
    • UpdateTagResponse
    • UpdateTagRuleResponse
    • UpdateUserResponse
    • UpdateUserTagAssignmentResponse
    • UnarchiveSurveyResponse
    • UpdateVirtualCurrencyResponse
    • UpdateWorkspaceConfigurationResponse
    • WorkspaceConfiguration
    • UpdateStreakRuleTagAssignmentsResponse
    • UpdateUserTagAssignmentsResponse
    • WorkspaceCode
    • UpdateSurveyResponse
    • UpdateSurveyTagAssignmentResponse
    • UpdateSurveyTagAssignmentsResponse
  1. Learning Groups

Get learning group

GET
/learning-groups/{learningGroupId}
LearningGroups
Retrieve a specific learning group by ID, with optional translations, tags, and items.

Request

Path Params

Query Params

Responses

🟢200OK
application/json
Learning group retrieved successfully
Body

🟠401Unauthorized
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/learning-groups/?catalogWorkspaceId&fields'
Response Response Example
{
    "learningGroupId": "string",
    "type": "custom",
    "title": "string",
    "description": "string",
    "image": "http://example.com",
    "estimatedDuration": 0,
    "origin": "CATALOG",
    "legacyLearningGroupId": "string",
    "catalogWorkspaceId": "stringstri",
    "catalogLearningGroupId": "string",
    "defaultLang": "en",
    "langs": [
        "en"
    ],
    "items": [
        null
    ],
    "defaultLayoutId": "string",
    "background": "string",
    "textColor": "string",
    "boxColor": "string",
    "backgroundImage": "http://example.com",
    "backgroundSize": "cover",
    "backgroundPosition": "center",
    "fontFamily": "string",
    "contentJustify": "start",
    "completionRule": {
        "==": [
            1,
            1
        ]
    },
    "outcomeRule": {
        "==": [
            1,
            1
        ]
    },
    "startRule": {
        "==": [
            1,
            1
        ]
    },
    "source": "string",
    "parentId": "string",
    "parentType": "learningPath",
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "tags": [
        {
            "tagId": "string",
            "priority": 0,
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "translations": [
        {
            "workspaceId": "stringstri",
            "learningGroupId": "string",
            "lang": "en",
            "title": "string",
            "image": "http://example.com",
            "description": "string",
            "accountId": "stringstri",
            "sourceRegion": "us-east-1",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ]
}
Modified at 2026-04-02 15:44:24
Previous
Create learning group
Next
Update learning group
Built with