Returns the enrolment.

  • Published on Oct 27, 2025
  • 2 minute(s) read
Prev Next
Get
/assignments/{assignmentId}/enrolments/{enrolmentId}

An endpoint to return an enrolment by enrolmentId

Security
HTTP
Type basic

To pass the authentication step you will need to provide the following:

Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received

Path parameters
enrolmentId
stringRequired

The enrolment ID

Example63f57d805d8ecbf46f5b5278
assignmentId
stringRequired

The assignment ID

Example12347d805d8ecbf46f5b5278
Responses
200

The enrolment

Expand All
object

A record associated with a specific user and a specific assignment to track the completion process.

id
string

The enrolment ID

Example63f8c80136c4d82bba43efa0
userId
string

The assignee user ID

Example63feb359efcdc6f51a621bcd
assignmentId
string

The assignment ID

Example63feb35e1124643b940eeeca
audienceId
string

The audience ID

Example63feb36222c0c0685b9d1eb7
primaryContentId
string

The assigned content ID

Example63feb366c1fcc8d6a4a8abc7
status
string

Enrolment statuses:

  • Archived is a status where the enrolment is no longer relevant to the user
  • Complete is a status where the enrolment has a recorded completion before the due date
  • Open is where the enrolment becomes active for completion
  • Overdue is where the assignment has no completion recorded but has exceeded the due date
  • Scheduled is where the assignment has been scheduled for the current recurring period
  • Unassigned is a status set to 'previous status' in the eventLog when the enrolment is created
Valid values[ "archived", "complete", "open", "overdue", "scheduled", "unassigned" ]
availableDate
string (date-time)

The date on which a scheduled enrolment will become open

Example2023-08-23T09:09:16.076Z
dueDate
string (date-time)

The date after which a scheduled enrolment will become overdue

Example2023-09-23T09:09:16.076Z
lastCompletedAt
string (date-time)

The date on which a scheduled enrolment was last completed

Example2023-08-24T09:09:16.076Z
history
Array of object
object
type
string

The type of the event being logged for historical purposes.

Valid values[ "assignment-created", "assignment-removed", "assignment-updated", "audience-deleted", "completion-import", "completion-on-system", "content-archived", "content-deleted", "scheduled-check", "user-added-to-audience", "user-removed-from-audience", "user-suspended" ]
completionId
string

The completion ID

Example63f8c80136c4d82bba43efa0
previousStatus
string

Enrolment statuses:

  • Archived is a status where the enrolment is no longer relevant to the user
  • Complete is a status where the enrolment has a recorded completion before the due date
  • Open is where the enrolment becomes active for completion
  • Overdue is where the assignment has no completion recorded but has exceeded the due date
  • Scheduled is where the assignment has been scheduled for the current recurring period
  • Unassigned is a status set to 'previous status' in the eventLog when the enrolment is created
Valid values[ "archived", "complete", "open", "overdue", "scheduled", "unassigned" ]
nextStatus
string

Enrolment statuses:

  • Archived is a status where the enrolment is no longer relevant to the user
  • Complete is a status where the enrolment has a recorded completion before the due date
  • Open is where the enrolment becomes active for completion
  • Overdue is where the assignment has no completion recorded but has exceeded the due date
  • Scheduled is where the assignment has been scheduled for the current recurring period
  • Unassigned is a status set to 'previous status' in the eventLog when the enrolment is created
Valid values[ "archived", "complete", "open", "overdue", "scheduled", "unassigned" ]
createdAt
string (date-time)

The date on which the event was logged

Example2023-08-24T09:09:16.076Z
updatedAt
string (date-time)

The date on which the event was last modified

Example2023-08-24T09:09:16.076Z
updatedAt
string (date-time)

The date on which an enrolment was last updated

Example2023-08-24T09:09:16.076Z
401

Unauthorized

object

Unauthorized

status
number
Example401.0
error
string
ExampleUnauthorized
message
string
403

Forbidden

object

Forbidden

status
number
Example403.0
error
string
ExampleForbidden
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
404

Not Found

object

Not found

status
number
Example404.0
error
string
ExampleNot Found
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
422

Unprocessable Content

object

Unprocessable Content

status
number
Example422.0
error
string
ExampleUnprocessable Content
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
default

Internal Server Error

object

Internal Server Error

status
number
Example500.0
error
string
ExampleInternal Server Error
message
string