GET
/
api
/
lms
/
v1
/
courses
/
{id}
Get Lms Course By Id
curl --request GET \
  --url https://api.bindbee.dev/api/lms/v1/courses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "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"
  },
  "name": "Python for Data Science",
  "description": "Introductory course",
  "cover_image": "https://img.example.com/py.png",
  "url": "https://lms.example.com/course/py",
  "duration": "PT5H30M",
  "languages": [
    "en_US"
  ],
  "categories": [
    "018b18ef-c487-703c-afd9-0ca478ccd9d6"
  ],
  "contents": [
    "018b18ef-c487-703c-afd9-0ca478ccd9d6"
  ],
  "skills": [
    "018b18ef-c487-703c-afd9-0ca478ccd9d6"
  ],
  "instructors": [
    "018b18ef-c487-703c-afd9-0ca478ccd9d6"
  ],
  "status": "ACTIVE"
}

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.

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

​
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.

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
object | null
required

The custom fields related to the model

Example:
{
  "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"
}
​
raw_data
object | null

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}
​
name
string | null

The name of the course

Example:

"Python for Data Science"

​
description
string | null

The description of the course

Example:

"Introductory course"

​
cover_image
string | null

The URL of the cover image of the course

Example:

"https://img.example.com/py.png"

​
url
string | null

The URL of the course

Example:

"https://lms.example.com/course/py"

​
duration
string | null

The duration of the course in ISO 8601 format

Example:

"PT5H30M"

​
languages
string[] | null

The languages of the course

Example:
["en_US"]
​
categories
any[] | null

The categories of the course

Example:
["018b18ef-c487-703c-afd9-0ca478ccd9d6"]
​
contents
any[] | null

The contents of the course

Example:
["018b18ef-c487-703c-afd9-0ca478ccd9d6"]
​
skills
any[] | null

The skills of the course

Example:
["018b18ef-c487-703c-afd9-0ca478ccd9d6"]
​
instructors
any[] | null

The instructors of the course

Example:
["018b18ef-c487-703c-afd9-0ca478ccd9d6"]
​
status
string | null

The status of the course. Possible values include: ACTIVE, PENDING, INACTIVE or - in cases where there is no clear mapping - the original value passed through

Example:

"ACTIVE"