Returns a list of completion records.

Prev Next
Get
/learning/completions

An endpoint to return the list of content completion records.

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
id
stringRequired

Filter by user

Example64676ab0a236ebc50f280a55
Query parameters
contentId
string

Filter by content

Example6467717bde7816256123b06a
isRPL
boolean

Filter by completions imported via RPL

Exampletrue
completedDateRangeStart
string (date or date-time)

Filter by completedDate (completedDate >= completedDateRangeStart)

Example2024-04-02 or 2024-04-02T12:00:00Z
completedDateRangeEnd
string (date or date-time)

Filter by completedDate (completedDate <= completedDateRangeEnd)

Example2024-04-02 or 2024-04-02T12:00:00Z
page
integer (int64)

Set the current page of results

Minimum1.0
Default1
perPage
integer (int64)

Used in combination with the page parameter to page through the data, will be prioritised over limit.

Allowed values: 1–1000

Minimum1.0
Maximum1000.0
Default1000
limit
integer (int64)

Set the number of items to retrieve per page

Minimum1.0
Maximum1000.0
Default1000
Responses
200

List of completion records

Array of object
object

The completion record

id
string

The completion ID

Example646767c6b808667ea07d13bf
userId
string

The user ID

Example646767d82535201223349e09
contentId
string

The content ID for the content completed

Example646767ee9b667f9b87db851a
contentVersion
number

The version of the content

Example1.0
skills
Array

The skills acquired through learning this content

Example[ "leadership" ]
completionType
string

The type of completion record

Exampledefault
hadDueDate
boolean

Defines Whether the completion had a due date

Examplefalse
isRPL
boolean

Defines Whether the completion was imported via the Recognition of Prior Learning process

Examplefalse
completedAt
string (date-time)

An ISO8601 for the timestamp when the completion occurred

Example2021-01-01T09:00:00Z
activeUntil
string (date-time)

An ISO8601 for the timestamp when the completion is valid until

Example2021-01-01T09:00:00Z
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
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