Get learning path

GET

/learning-paths/{learningPathId}

LearningPaths

Retrieve a specific learning path by ID, with optional translations, tags, items, and assignments.

Request

Path Params

Query Params

Responses

🟢200OK

application/json

Learning path retrieved successfully

Body

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/learning-paths/?catalogWorkspaceId&fields'

Response Example

{
    "learningPathId": "string",
    "origin": "CATALOG",
    "catalogWorkspaceId": "stringstri",
    "catalogLearningPathId": "string",
    "legacyLearningPathId": "string",
    "title": "string",
    "description": "string",
    "image": "http://example.com",
    "estimatedDuration": 0,
    "defaultLang": "en",
    "langs": [
        "en"
    ],
    "items": [
        null
    ],
    "activities": [
        {
            "itemId": "string",
            "itemType": "activity",
            "languages": [
                "en"
            ]
        }
    ],
    "contentThemeId": "string",
    "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
        ]
    },
    "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",
            "learningPathId": "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"
        }
    ],
    "assignments": [
        {
            "learningPathAssignmentId": "string",
            "learningPathId": "string",
            "userId": "string",
            "learningPathRuleId": "string",
            "groupId": "string",
            "periodId": "string",
            "timeframeType": "PERMANENT",
            "startsAt": "2019-08-24T14:15:22.123Z",
            "endsAt": "2019-08-24T14:15:22.123Z",
            "state": "PENDING",
            "visibility": "LOCKED",
            "unlockedAt": "2019-08-24T14:15:22.123Z",
            "unlockedByRuleId": "string",
            "currentAttempt": 1,
            "accountId": "stringstri",
            "workspaceId": "stringstri",
            "sourceRegion": "us-east-1",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "user": {
                "userId": "string",
                "nickname": "string",
                "profileImage": "http://example.com"
            }
        }
    ]
}

Modified at 2026-04-02 15:44:24

Create learning path

Update learning path