Skip to main content
GET
Get Lms Course By Id

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

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

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<date-time>
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:
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[]

The languages of the course as locale codes (e.g. en_US, fr_FR, de_DE).

Example:
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. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"ACTIVE"