Skip to main content
GET
/
unified
/
lms
/
users
/
{id}
/
completions
/
{subResourceId}
Get User Completion
curl --request GET \
  --url https://api.stackone.com/unified/lms/users/{id}/completions/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "data": {
    "id": "123456",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "learning_object_external_reference": "learning-content-123",
    "external_reference": "e3gd34-23tr21-er234-345er56",
    "result": {
      "value": "Pass",
      "source_value": "<string>"
    },
    "completed_at": "2021-07-21T14:00:00.000Z",
    "created_at": "2021-07-21T14:00:00.000Z",
    "updated_at": "2021-07-21T14:00:00.000Z",
    "learning_object_type": {
      "value": "content",
      "source_value": "<string>"
    },
    "learning_object_id": "e3gd34-23tr21-er234-345er56",
    "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49",
    "user_id": "c28xyrc55866bvuv",
    "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "time_spent": "PT1H30M45S",
    "certificate_url": "https://example.com/certificate/12345",
    "external_id": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION",
    "content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT",
    "remote_external_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "content_id": "16873-ENG-VIDEO-1",
    "remote_content_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "course_id": "16873-ENG-COURSE-1",
    "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "score": {
      "percentage": 87,
      "raw_value": "87 / 100"
    }
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

​
Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Path Parameters

​
id
string
required
​
subResourceId
string
required

Query Parameters

​
raw
boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

​
proxy
object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

​
fields
string | null

The comma separated list of fields to return in the response (if empty, all fields are returned)

Response

The completion with the given identifier was retrieved.

​
data
object
required
​
raw
object[] | null