Skip to main content
GET
/
api
/
v1
/
learn
/
registrations
/
{registration_id}
Get Registration
curl --request GET \
  --url https://api.example.com/api/v1/learn/registrations/{registration_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "score_percent": 123,
  "time_spent_seconds": 0,
  "attempt_count": 0,
  "last_status_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
registration_id
string<uuid>
required

Query Parameters

​
expand
boolean
default:false

Include enriched data (user/course/ship names)

Response

Successful Response

Registration data transfer object - returned from repositories. Represents a course enrollment/registration record.

Note: The registration.id is used as the xAPI registration ID.

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
assignment_id
string<uuid>
required
​
course_id
string<uuid>
required
​
status
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
completed_at
string<date-time> | null
​
score_percent
integer | null
​
time_spent_seconds
integer
default:0
​
attempt_count
integer
default:0
​
last_status_at
string<date-time> | null