Get learning path assignment

GET

/learning-path-assignments/{learningPathAssignmentId}

LearningPathAssignments

Retrieve a specific learning path assignment by ID, with optional additional fields (translation, tags, items, progress).

Request

Path Params

Query Params

Responses

🟢200OK

application/json

Learning path assignment retrieved successfully

Body

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/learning-path-assignments/?context&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": [],
    "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
        ]
    },
    "learningPathAssignmentId": "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,
    "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"
        }
    ],
    "translation": {
        "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"
    },
    "progress": {
        "status": "NOT_STARTED",
        "outcome": "SUCCESS",
        "attempt": 1,
        "progress": {
            "total": 0,
            "completed": 0,
            "percentage": 0
        },
        "items": [
            {
                "itemId": "string",
                "itemType": "activity",
                "progress": "START",
                "outcome": "SUCCESS",
                "childItems": [
                    {
                        "itemId": "string",
                        "itemType": "string",
                        "outcome": "SUCCESS"
                    }
                ]
            }
        ],
        "currentItemId": "string",
        "currentItemType": "activity",
        "startedAt": "string",
        "completedAt": "string"
    }
}

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

List learning path assignments

Get current attempt