Version: v1

Absorb Integration API (v1)

Download OpenAPI specification:Download

Courses

Lists courses.

Lists all selected LMS courses that are available to the current, authenticated administrator.

Authorizations:

api_key

query Parameters

modifiedSince	string <date-time> (Deprecated) The specified date for filtering courses that were edited after this date.
externalId	string (Deprecated) The specified external ID to filter by.
limit	string (Deprecated) The maximum number of items to return in the current page of the collection.
offset	string (Deprecated) The number of pages to offset into the collection.
_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (CourseResource) The paged collection of resources.

Response samples

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"courses": [{"id": "string",
"courseType": "string",
"name": "string",
"description": "string",
"notes": "string",
"externalId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"expireType": 0,
"expireDuration": {"years": 0,
"months": 0,
"days": 0,
"hours": 0
},
"expiryDate": "2019-08-24T14:15:22Z",
"activeStatus": 0,
"tagIds": ["string"
],
"resourceIds": ["string"
],
"editorIds": ["string"
],
"prices": [{"id": "string",
"departmentId": "string",
"currency": "string",
"amount": 0
}
],
"competencyDefinitionIds": ["string"
],
"prerequisiteCourseIds": ["string"
],
"postEnrollmentCourseIds": ["string"
],
"allowCourseEvaluation": true,
"categoryId": "string",
"certificateUrl": "string",
"audience": "string",
"goals": "string",
"vendor": "string",
"companyCost": 0,
"learnerCost": 0,
"companyTime": 0,
"learnerTime": 0,
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]
}

Get course.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The course ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The unique course identifier.
courseType	string The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string The course's name.
description	string The course's description. Supports HTML.
notes	string The course's notes.
externalId	string The course's external ID.
accessDate	string <date-time> The course's access date.
expireType	integer Enum: 0 1 2 The course's expiry type. Possible Enum Values: `0 = None` `1 = Date` `2 = Duration`
	object The course's duration until expiry, if applicable.
expiryDate	string <date-time> The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 The course's status. Possible Enum Values: `0 = Active` `1 = Inactive`
tagIds	Array of strings <guid> [ items <guid > ] The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] The course's list of editor IDs.
	Array of objects (PriceResource) The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean True if the course allows evaluation, false otherwise.
categoryId	string <guid> The course's category ID.
certificateUrl	string The course's certificate URL, if any.
audience	string The course's audience.
goals	string The course's goals.
vendor	string The course's vendor.
companyCost	number <decimal> The course's company cost.
learnerCost	number <decimal> The course's learner cost.
companyTime	number <decimal> The course's amount of company time.
learnerTime	number <decimal> The course's amount of learner time.
dateEdited	string <date-time> The course's last edited date.
dateAdded	string <date-time> The date the course was added.

Response samples

Content type

application/json

{"id": "string",
"courseType": "string",
"name": "string",
"description": "string",
"notes": "string",
"externalId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"expireType": 0,
"expireDuration": {"years": 0,
"months": 0,
"days": 0,
"hours": 0
},
"expiryDate": "2019-08-24T14:15:22Z",
"activeStatus": 0,
"tagIds": ["string"
],
"resourceIds": ["string"
],
"editorIds": ["string"
],
"prices": [{"id": "string",
"departmentId": "string",
"currency": "string",
"amount": 0
}
],
"competencyDefinitionIds": ["string"
],
"prerequisiteCourseIds": ["string"
],
"postEnrollmentCourseIds": ["string"
],
"allowCourseEvaluation": true,
"categoryId": "string",
"certificateUrl": "string",
"audience": "string",
"goals": "string",
"vendor": "string",
"companyCost": 0,
"learnerCost": 0,
"companyTime": 0,
"learnerTime": 0,
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}

List user's available courses.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The user ID.

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> `Filterable` The unique course identifier.
courseType	string `Sortable` `Filterable` The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string `Default Sort` `Sortable` `Filterable` The course's name.
description	string `Filterable` The course's description. Supports HTML.
notes	string `Filterable` The course's notes.
externalId	string `Sortable` `Filterable` The course's external ID.
accessDate	string <date-time> `Sortable` `Filterable` The course's access date.
expireType	integer Enum: 0 1 2 `Sortable` `Filterable` The course's expiry type. Possible Enum Values: `0 = None` `1 = Date` `2 = Duration`
	object `Filterable` The course's duration until expiry, if applicable.
expiryDate	string <date-time> `Sortable` `Filterable` The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 `Sortable` `Filterable` The course's status. Possible Enum Values: `0 = Active` `1 = Inactive`
tagIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of editor IDs.
	Array of objects (PriceResource) `Filterable` The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean `Sortable` `Filterable` True if the course allows evaluation, false otherwise.
categoryId	string <guid> `Sortable` `Filterable` The course's category ID.
certificateUrl	string `Sortable` `Filterable` The course's certificate URL, if any.
audience	string `Sortable` `Filterable` The course's audience.
goals	string `Sortable` `Filterable` The course's goals.
vendor	string `Sortable` `Filterable` The course's vendor.
companyCost	number <decimal> `Sortable` `Filterable` The course's company cost.
learnerCost	number <decimal> `Sortable` `Filterable` The course's learner cost.
companyTime	number <decimal> `Sortable` `Filterable` The course's amount of company time.
learnerTime	number <decimal> `Sortable` `Filterable` The course's amount of learner time.
dateEdited	string <date-time> `Sortable` `Filterable` The course's last edited date.
dateAdded	string <date-time> `Sortable` `Filterable` The date the course was added.

Response samples

Content type

application/json

[{"id": "string",
"courseType": "string",
"name": "string",
"description": "string",
"notes": "string",
"externalId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"expireType": 0,
"expireDuration": {"years": 0,
"months": 0,
"days": 0,
"hours": 0
},
"expiryDate": "2019-08-24T14:15:22Z",
"activeStatus": 0,
"tagIds": ["string"
],
"resourceIds": ["string"
],
"editorIds": ["string"
],
"prices": [{"id": "string",
"departmentId": "string",
"currency": "string",
"amount": 0
}
],
"competencyDefinitionIds": ["string"
],
"prerequisiteCourseIds": ["string"
],
"postEnrollmentCourseIds": ["string"
],
"allowCourseEvaluation": true,
"categoryId": "string",
"certificateUrl": "string",
"audience": "string",
"goals": "string",
"vendor": "string",
"companyCost": 0,
"learnerCost": 0,
"companyTime": 0,
"learnerTime": 0,
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]

List user's available courses.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The user ID.

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> `Filterable` The unique course identifier.
courseType	string `Sortable` `Filterable` The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string `Default Sort` `Sortable` `Filterable` The course's name.
description	string `Filterable` The course's description. Supports HTML.
notes	string `Filterable` The course's notes.
externalId	string `Sortable` `Filterable` The course's external ID.
accessDate	string <date-time> `Sortable` `Filterable` The course's access date.
expireType	integer Enum: 0 1 2 `Sortable` `Filterable` The course's expiry type. Possible Enum Values: `0 = None` `1 = Date` `2 = Duration`
	object `Filterable` The course's duration until expiry, if applicable.
expiryDate	string <date-time> `Sortable` `Filterable` The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 `Sortable` `Filterable` The course's status. Possible Enum Values: `0 = Active` `1 = Inactive`
tagIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of editor IDs.
	Array of objects (PriceResource) `Filterable` The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean `Sortable` `Filterable` True if the course allows evaluation, false otherwise.
categoryId	string <guid> `Sortable` `Filterable` The course's category ID.
certificateUrl	string `Sortable` `Filterable` The course's certificate URL, if any.
audience	string `Sortable` `Filterable` The course's audience.
goals	string `Sortable` `Filterable` The course's goals.
vendor	string `Sortable` `Filterable` The course's vendor.
companyCost	number <decimal> `Sortable` `Filterable` The course's company cost.
learnerCost	number <decimal> `Sortable` `Filterable` The course's learner cost.
companyTime	number <decimal> `Sortable` `Filterable` The course's amount of company time.
learnerTime	number <decimal> `Sortable` `Filterable` The course's amount of learner time.
dateEdited	string <date-time> `Sortable` `Filterable` The course's last edited date.
dateAdded	string <date-time> `Sortable` `Filterable` The date the course was added.

Response samples

Content type

application/json

[{"id": "string",
"courseType": "string",
"name": "string",
"description": "string",
"notes": "string",
"externalId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"expireType": 0,
"expireDuration": {"years": 0,
"months": 0,
"days": 0,
"hours": 0
},
"expiryDate": "2019-08-24T14:15:22Z",
"activeStatus": 0,
"tagIds": ["string"
],
"resourceIds": ["string"
],
"editorIds": ["string"
],
"prices": [{"id": "string",
"departmentId": "string",
"currency": "string",
"amount": 0
}
],
"competencyDefinitionIds": ["string"
],
"prerequisiteCourseIds": ["string"
],
"postEnrollmentCourseIds": ["string"
],
"allowCourseEvaluation": true,
"categoryId": "string",
"certificateUrl": "string",
"audience": "string",
"goals": "string",
"vendor": "string",
"companyCost": 0,
"learnerCost": 0,
"companyTime": 0,
"learnerTime": 0,
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]

List courses for sale.

Authorizations:

api_key

query Parameters

id	string <guid> The course ID.
categoryId	string <guid> The category ID.
from	string <date-time> The course's start date.
to	string <date-time> The course's expiry date.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The unique course identifier.
courseType	string The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string The course's name.
description	string The course's description. Supports HTML.
notes	string The course's notes.
externalId	string The course's external ID.
accessDate	string <date-time> The course's access date.
expireType	integer Enum: 0 1 2 The course's expiry type. Possible Enum Values: `0 = None` `1 = Date` `2 = Duration`
	object The course's duration until expiry, if applicable.
expiryDate	string <date-time> The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 The course's status. Possible Enum Values: `0 = Active` `1 = Inactive`
tagIds	Array of strings <guid> [ items <guid > ] The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] The course's list of editor IDs.
	Array of objects (PriceResource) The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean True if the course allows evaluation, false otherwise.
categoryId	string <guid> The course's category ID.
certificateUrl	string The course's certificate URL, if any.
audience	string The course's audience.
goals	string The course's goals.
vendor	string The course's vendor.
companyCost	number <decimal> The course's company cost.
learnerCost	number <decimal> The course's learner cost.
companyTime	number <decimal> The course's amount of company time.
learnerTime	number <decimal> The course's amount of learner time.
dateEdited	string <date-time> The course's last edited date.
dateAdded	string <date-time> The date the course was added.

Response samples

Content type

application/json

[{"id": "string",
"courseType": "string",
"name": "string",
"description": "string",
"notes": "string",
"externalId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"expireType": 0,
"expireDuration": {"years": 0,
"months": 0,
"days": 0,
"hours": 0
},
"expiryDate": "2019-08-24T14:15:22Z",
"activeStatus": 0,
"tagIds": ["string"
],
"resourceIds": ["string"
],
"editorIds": ["string"
],
"prices": [{"id": "string",
"departmentId": "string",
"currency": "string",
"amount": 0
}
],
"competencyDefinitionIds": ["string"
],
"prerequisiteCourseIds": ["string"
],
"postEnrollmentCourseIds": ["string"
],
"allowCourseEvaluation": true,
"categoryId": "string",
"certificateUrl": "string",
"audience": "string",
"goals": "string",
"vendor": "string",
"companyCost": 0,
"learnerCost": 0,
"companyTime": 0,
"learnerTime": 0,
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]

List currently authenticated user's available courses.

Authorizations:

api_key

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> `Filterable` The unique course identifier.
courseType	string `Sortable` `Filterable` The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string `Default Sort` `Sortable` `Filterable` The course's name.
description	string `Filterable` The course's description. Supports HTML.
notes	string `Filterable` The course's notes.
externalId	string `Sortable` `Filterable` The course's external ID.
accessDate	string <date-time> `Sortable` `Filterable` The course's access date.
expireType	integer Enum: 0 1 2 `Sortable` `Filterable` The course's expiry type. Possible Enum Values: `0 = None` `1 = Date` `2 = Duration`
	object `Filterable` The course's duration until expiry, if applicable.
expiryDate	string <date-time> `Sortable` `Filterable` The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 `Sortable` `Filterable` The course's status. Possible Enum Values: `0 = Active` `1 = Inactive`
tagIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of editor IDs.
	Array of objects (PriceResource) `Filterable` The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean `Sortable` `Filterable` True if the course allows evaluation, false otherwise.
categoryId	string <guid> `Sortable` `Filterable` The course's category ID.
certificateUrl	string `Sortable` `Filterable` The course's certificate URL, if any.
audience	string `Sortable` `Filterable` The course's audience.
goals	string `Sortable` `Filterable` The course's goals.
vendor	string `Sortable` `Filterable` The course's vendor.
companyCost	number <decimal> `Sortable` `Filterable` The course's company cost.
learnerCost	number <decimal> `Sortable` `Filterable` The course's learner cost.
companyTime	number <decimal> `Sortable` `Filterable` The course's amount of company time.
learnerTime	number <decimal> `Sortable` `Filterable` The course's amount of learner time.
dateEdited	string <date-time> `Sortable` `Filterable` The course's last edited date.
dateAdded	string <date-time> `Sortable` `Filterable` The date the course was added.

Response samples

Content type

application/json

[{"id": "string",
"courseType": "string",
"name": "string",
"description": "string",
"notes": "string",
"externalId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"expireType": 0,
"expireDuration": {"years": 0,
"months": 0,
"days": 0,
"hours": 0
},
"expiryDate": "2019-08-24T14:15:22Z",
"activeStatus": 0,
"tagIds": ["string"
],
"resourceIds": ["string"
],
"editorIds": ["string"
],
"prices": [{"id": "string",
"departmentId": "string",
"currency": "string",
"amount": 0
}
],
"competencyDefinitionIds": ["string"
],
"prerequisiteCourseIds": ["string"
],
"postEnrollmentCourseIds": ["string"
],
"allowCourseEvaluation": true,
"categoryId": "string",
"certificateUrl": "string",
"audience": "string",
"goals": "string",
"vendor": "string",
"companyCost": 0,
"learnerCost": 0,
"companyTime": 0,
"learnerTime": 0,
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]

List currently authenticated user's available courses.

Authorizations:

api_key

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> `Filterable` The unique course identifier.
courseType	string `Sortable` `Filterable` The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string `Default Sort` `Sortable` `Filterable` The course's name.
description	string `Filterable` The course's description. Supports HTML.
notes	string `Filterable` The course's notes.
externalId	string `Sortable` `Filterable` The course's external ID.
accessDate	string <date-time> `Sortable` `Filterable` The course's access date.
expireType	integer Enum: 0 1 2 `Sortable` `Filterable` The course's expiry type. Possible Enum Values: `0 = None` `1 = Date` `2 = Duration`
	object `Filterable` The course's duration until expiry, if applicable.
expiryDate	string <date-time> `Sortable` `Filterable` The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 `Sortable` `Filterable` The course's status. Possible Enum Values: `0 = Active` `1 = Inactive`
tagIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of editor IDs.
	Array of objects (PriceResource) `Filterable` The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] `Filterable` The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean `Sortable` `Filterable` True if the course allows evaluation, false otherwise.
categoryId	string <guid> `Sortable` `Filterable` The course's category ID.
certificateUrl	string `Sortable` `Filterable` The course's certificate URL, if any.
audience	string `Sortable` `Filterable` The course's audience.
goals	string `Sortable` `Filterable` The course's goals.
vendor	string `Sortable` `Filterable` The course's vendor.
companyCost	number <decimal> `Sortable` `Filterable` The course's company cost.
learnerCost	number <decimal> `Sortable` `Filterable` The course's learner cost.
companyTime	number <decimal> `Sortable` `Filterable` The course's amount of company time.
learnerTime	number <decimal> `Sortable` `Filterable` The course's amount of learner time.
dateEdited	string <date-time> `Sortable` `Filterable` The course's last edited date.
dateAdded	string <date-time> `Sortable` `Filterable` The date the course was added.

Response samples

Content type

application/json

[{"id": "string",
"courseType": "string",
"name": "string",
"description": "string",
"notes": "string",
"externalId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"expireType": 0,
"expireDuration": {"years": 0,
"months": 0,
"days": 0,
"hours": 0
},
"expiryDate": "2019-08-24T14:15:22Z",
"activeStatus": 0,
"tagIds": ["string"
],
"resourceIds": ["string"
],
"editorIds": ["string"
],
"prices": [{"id": "string",
"departmentId": "string",
"currency": "string",
"amount": 0
}
],
"competencyDefinitionIds": ["string"
],
"prerequisiteCourseIds": ["string"
],
"postEnrollmentCourseIds": ["string"
],
"allowCourseEvaluation": true,
"categoryId": "string",
"certificateUrl": "string",
"audience": "string",
"goals": "string",
"vendor": "string",
"companyCost": 0,
"learnerCost": 0,
"companyTime": 0,
"learnerTime": 0,
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]