List Completions

GET

unified

lms

completions

curl --request GET \
  --url https://api.stackone.com/unified/lms/completions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next": "<string>",
  "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"
      },
      "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",
      "learning_object_external_reference": "learning-content-123",
      "user_id": "c28xyrc55866bvuv",
      "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "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"
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "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

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

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 that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference"

filter

object | null

LMS Completions Filter

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

string | null

The unified cursor

updated_after

string | null

deprecated

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

Response

200

application/json

The list of completions was retrieved.

data

object[]

required

data.id

string | null

The ID associated with this completion

Example:

"123456"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.external_reference

string | null

deprecated

The external reference associated with this completion

Example:

"e3gd34-23tr21-er234-345er56"

data.result

object

The result of the completion

data.completed_at

string | null

The date the content was completed

Example:

"2021-07-21T14:00:00.000Z"

data.created_at

string | null

The created date of the completion

Example:

"2021-07-21T14:00:00.000Z"

data.updated_at

string | null

The updated date of the completion

Example:

"2021-07-21T14:00:00.000Z"

data.learning_object_type

object

The learning object type of the completion

data.learning_object_id

string | null

The id of the learning object associated with this completion. This is not required unless specified in an integration.

Example:

"e3gd34-23tr21-er234-345er56"

data.remote_learning_object_id

string | null

Provider's unique identifier of the learning object related to the completion

Example:

"e3cb55bf-aa84-466e-a6c1-b8302b257a49"

data.learning_object_external_reference

string | null

The external reference of the learning object associated with this completion, this is the main identifier for creating completions.

Example:

"learning-content-123"

data.user_id

string | null

The user ID associated with this completion

Example:

"c28xyrc55866bvuv"

data.remote_user_id

string | null

Provider's unique identifier of the user related to the completion

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.external_id

string | null

deprecated

The external ID associated with this completion

Example:

"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION"

data.content_external_reference

string | null

deprecated

The external reference associated with this content

Example:

"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT"

data.remote_external_id

string | null

deprecated

Provider's unique identifier of the content external reference

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.content_id

string | null

deprecated

The content ID associated with this completion

Example:

"16873-ENG-VIDEO-1"

data.remote_content_id

string | null

deprecated

Provider's unique identifier of the content associated with the completion

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.course_id

string | null

deprecated

The course ID associated with this completion

Example:

"16873-ENG-COURSE-1"

data.remote_course_id

string | null

deprecated

Provider's unique identifier of the course associated with the completion

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

string | null

raw

object[] | null

Was this page helpful?

Suggest edits

Get Completion Batch Upsert Content

curl --request GET \
  --url https://api.stackone.com/unified/lms/completions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next": "<string>",
  "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"
      },
      "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",
      "learning_object_external_reference": "learning-content-123",
      "user_id": "c28xyrc55866bvuv",
      "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "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"
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

LMS

Common Guides

API Reference

Authorizations

Headers

Query Parameters

Response