Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Contents

Get Lms Contents

Returns a list of LMS Content objects.

get/api/lms/v1/contents

Query parameters

remote_idstring

The third-party API ID of the matching object.

The third-party API ID of the matching object.

idsstring nullable

If provided, will only return contents for these IDs.

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

If provided, will only return contents for these IDs.

coursesstring nullable

If provided, will only return contents for these courses.

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

If provided, will only return contents for these courses.

skillsstring nullable

If provided, will only return contents for these skills.

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

If provided, will only return contents for these skills.

categoriesstring nullable

If provided, will only return contents for these categories.

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

If provided, will only return contents for these categories.

languagesstring

If provided, will only return contents for these languages.

Example:en_US,en_UK

If provided, will only return contents for these languages.

status'ACTIVE' | 'PENDING' | 'INACTIVE'

If provided, will only return contents for this status.

include_raw_databoolean

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

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.

Whether to include custom fields in the response.

page_sizeinteger

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

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

cursorstring

The pagination cursor value.

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.

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"
      },
      "title": "NumPy Basics",
      "description": "Array manipulation",
      "languages": [
        "en_US",
        "en_GB"
      ],
      "cover_image": "https://img.example.com/numpy.png",
      "url": "https://lms.example.com/content/numpy",
      "duration": "PT45M",
      "order": 1,
      "provider": "Coursera",
      "status": "ACTIVE"
    }
  ]
}