v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Completions

Get Lms Completions

Returns a list of LMS Completion objects.

get/api/lms/v1/completions

Query parameters

idsstring nullable

A comma-separated list of LMS Completion IDs to filter by.

Example:018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7

A comma-separated list of LMS Completion IDs to filter by.

coursestring nullable

If provided, will only return completions for these courses.

Example:018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7

If provided, will only return completions for these courses.

userstring nullable

If provided, will only return completions for these users.

Example:018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7

If provided, will only return completions for these users.

contentstring nullable

If provided, will only return completions for these contents.

Example:018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7

If provided, will only return completions for these contents.

grade'A' | 'B' | 'C' | 'D' | 'F' | 'PASS' | 'FAIL' | '-'

If provided, will only return completions for this grade.

remote_idstring

The third-party API ID of the matching object.

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.

page_sizeinteger

Number of results to return per page. Maximum size is 200.

cursorstring

The pagination cursor value.

expandstring

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]

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.

started_at_fromstring

If provided, only objects with started_at same or after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with started_at same or after this date time will be returned. Format: DateTime (ISO 8601)

started_at_tostring

If provided, only objects with started_at same or before this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with started_at same or before this date time will be returned. Format: DateTime (ISO 8601)

completed_at_fromstring

If provided, only objects with completed_at same or after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with completed_at same or after this date time will be returned. Format: DateTime (ISO 8601)

completed_at_tostring

If provided, only objects with completed_at same or before this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with completed_at same or before this date time will be returned. Format: DateTime (ISO 8601)

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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"
    }
  ]
}