BIbindbee
Completions

Get Lms Completion By Id

Changed on

Returns an LMS Completion object with the given id.

get/api/lms/v1/completions/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

userstring nullable

The user who completed the course

coursestring nullable

The course that the user completed

contentstring nullable

The content that the user completed

scoreinteger nullable

The score obtained by the user

gradestring nullable

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.

started_atstring nullable

The date and time when the user started the course

completed_atstring nullable

The date and time when the user completed the course

time_durationstring nullable

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

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "user": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "course": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "content": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "score": 95,
  "grade": "PASS",
  "started_at": "2025-08-01T10:00:00Z",
  "completed_at": "2025-08-01T11:15:00Z",
  "time_duration": "PT1H15M"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the A enum value from the response property for the response status

    • info

      removed the B enum value from the response property for the response status

    • info

      removed the C enum value from the response property for the response status

    • info

      removed the D enum value from the response property for the response status

    • info

      removed the F enum value from the response property for the response status

    • info

      removed the FAIL enum value from the response property for the response status

    • info

      removed the PASS enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API