Skip to main content
GET
Get Lms Completion By Id

Authorizations

Authorization
string
header
required

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

Headers

x-connector-token
string
required

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:

"manager[first_name,last_name]"

Response

Successful Response

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
raw_data
Raw Data · object | null

This is the Raw data

Example:
user
any | null

The user who completed the course

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

course
any | null

The course that the user completed

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

content
any | null

The content that the user completed

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

score
integer | null

The score obtained by the user

Example:

95

grade
enum<string>

The grade achieved by the user. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
A,
B,
C,
D,
F,
PASS,
FAIL,
-
Example:

"PASS"

started_at
string | null

The date and time when the user started the course

Example:

"2025-08-01T10:00:00Z"

completed_at
string | null

The date and time when the user completed the course

Example:

"2025-08-01T11:15:00Z"

time_duration
string | null

The time duration of the course used by the user in ISO 8601 format

Example:

"PT1H15M"