Get Path Assignment by ID

Get a specific path user assignment

get/api/v1/path_assignments/{assignment_id}

Request

  • Base URL
    https://app.workramp.com
  • URL
    https://app.workramp.com/api/v1/path_assignments/{assignment_id}
  • Auth
    API key in header Authorization

Path parameters

assignment_idstring required

ID of the path assignment to retrieve

Response

200

idstring
userIdinteger
titlestring
trainingSeriesIdstring
assignerIdinteger
overallGradeunknown
isCompletedboolean
dueDateinteger
createdAtinteger
updatedAtinteger
createdThroughunknown
numModulesinteger
modulesCompletedinteger
completionPercentageinteger
completedAtunknown
timeSpentunknown
statusstring
isCompletedOnTimeunknown
passedboolean
passingGradeRequiredunknown
isOverdueboolean
numDaysOverdueinteger
firstAccessedAtinteger
lastAccessedAtinteger

Example response

{
  "id": "805bfffa-9da6-11ed-b0ee-aa41bb3ba07e",
  "userId": 1,
  "title": "3rd generation",
  "trainingSeriesId": "802569c2-9da6-11ed-b0ee-aa41bb3ba07e",
  "assignerId": 1,
  "dueDate": 1675275796000,
  "createdAt": 1674757396199,
  "updatedAt": 1723154574722,
  "numModules": 5,
  "modulesCompleted": 2,
  "completionPercentage": 40,
  "status": "overdue",
  "isOverdue": true,
  "numDaysOverdue": 658,
  "firstAccessedAt": 1674757396199,
  "lastAccessedAt": 1723154574722
}

Changes

No recorded changes to this operation across all 1 revision of this API.