Non-logged-in APIs
Learn more about the Adobe Learning Manager APIs, which provide data for the headless or non-logged-in experience in this article.
Public Search API
Public Search API
Filter data using Public ES
The Public Search API allows you to get the filter data that can be used with the basic search API to filter the courses. This API provides all the filters that can be used in the search API.
Sample curl
Use the GET method to make the following request. Replace <Base_URL> with your base URL in the curl command below. You can find the <Base_URL> on the training data access connector page.
curl --location '<Base_URL>/filterableData'
Sample response
{
"terms": {
"loSkillLevels": [
"1"
],
"catalogNames": [
"Default Catalog"
],
"catalogLabelIds": [
"0000_1111"
],
"loType": [
"course"
],
"availability": [
"waitlistAvailable",
"seatAvailable"
],
"loSkillNames": [
"General"
],
"tags": [
"course_tag"
],
"authors": [
"author_1"
]
},
"range": {
"duration": [
"0"
],
"dateCreated": [
"2024-06-13T04:32:17.000Z"
],
"price": [
"0.0"
],
"sessionEndTime": [
"2024-06-18T20:30:00.000Z"
],
"averageRating": [
"0.0"
],
"sessionStartTime": [
"2024-06-18T19:30:00.000Z"
],
"publishDate": [
"2024-06-13T04:32:51.000Z"
],
"ratingsCount": [
"0"
]
},
"term": {}
}
Filter options
Options
Description
loSkillLevelshe proficiency level required for enrolling into the course.
catalogNamesList of available catalog names.
loTypeTypes of available learning objects.
availabilityThe seat availability and waitlist availability.
loSkillNamesThe skill names added to the learning objects.
tagsThe tags associated with the learning objects.
authorsThe author’s name of the learning objects
durationThe duration of the learning objects.
dateCreatedThe date the learning object was created.
sessionEndTimeThe time the session ended.
averageRatingThe average star rating of the learning objects.
sessionStartTimeThe time the session started.
publishDateThe published date of the learning object.
ratingsCountThe number of rating counts for the learning object.
Search API
The public Search API allows you to get basic search data using the provided data.
Sample Curl
Use the POST method to make the following request. Replace <Base_URL> with your base URL in the curl command below. You can find the <Base_URL> on the training data access connector page.
curl --location '<Base_URL>/search?size=1000' \
--header 'content-type: application/json'
--data '{
"query": "",
"sort": {
"name": "publishDate",
"order": "desc"
},
"lang": [
"en-US"
],
"filters": {
"terms": {
"loType": [
"course",
"learningProgram",
"certification"
],
"availability": [
"seatAvailable",
"waitlistAvailable"
]
},
"term": {
"enrollmentDeadlinePassed": "true"
},
"range": {
"dateCreated": [
{
"gte": "2024-05-02T02:48:51.000Z"
}
],
"sessionStartTime": [
{
"gte": "2024-06-18T19:30:00.000Z"
}
],
"sessionEndTime": [
{
"lte": "2024-06-20T09:30:00.000Z"
}
]
}
}
}'
Sample response of the API call
{
"results": [
{
"loId": "course:11332313",
"loType": "course",
"tags": [
"course_tag"
],
"authors": [
"author1",
"author2"
],
"status": "Published",
"duration": 0,
"publishDate": "2024-06-13T04:32:51.000Z",
"dateCreated": "2024-06-13T04:32:17.000Z",
"name": "vc coursse to check ",
"averageRating": 0.0,
"ratingsCount": 0,
"loSkillNames": [
"General"
],
"loSkillLevels": [
"1"
],
"loInstances": [
{
"id": "14346696",
"name": "Default Instance",
"status": "Active",
"price": 0.0
}
],
"catalogInfo": [
{
"id": "37779",
"name": "Default Catalog"
}
]
}
],
"request": {
"query": "",
"filters": {
"terms": {
"loType": [
"course",
"learningProgram",
"certification"
],
"loSkillNames": [
"General"
],
"deliveryType": [],
"availability": [
"seatAvailable",
"waitlistAvailable"
]
},
"term": {
"enrollmentDeadlinePassed": "true"
},
"range": {
"dateCreated": [
{
"gte": "2024-05-02T02:48:51.000Z"
}
],
"sessionStartTime": [
{
"gte": "2024-06-18T19:30:00.000Z"
}
],
"sessionEndTime": [
{
"lte": "2024-06-20T09:30:00.000Z"
}
]
}
},
"sort": {
"name": "publishDate",
"order": "desc"
},
"lang": [
"en-US"
]
},
"self": "<Base_URL>/search?page=0&size=1000",
"count": 1
}
Sort options on the Search API
You can select the following sorting options to be applied to the results.
Options
Description
durationThe duration of the learning object.
publishDateThe published date of the learning object.
dateCreatedThe date the learning object was created.
name_enThe name of the learning object.
averageRatingAverage star rating provided by the learners.
ratingsCountThe number of rating counts for the learning object.
relevance(default)The relevant data is based on the search keywords.
Get learning object data using Public search API
The Public ES Learning Object API lets you get the list of types and IDs of learning objects available on the headless interface.
Sample curl
Use the GET method to make the following request. Replace <Base_URL> with your base URL in the curl command below. You can find the <Base_URL> on the training data access connector page.
curl --location '<Base_URL>/learningObjectIds'
Sample response for the API call
{
"loIds": [
"course:1132800",
"certification:126009",
"learningProgram:104433"
]
}
Course summary API
The course summary API allows you to retrieve detailed information about a specific course.
Sample curl
Use the GET method to make the following request. Replace <Base_URL> with your base URL in the curl command below. You can find the <Base_URL> on the training data access connector page. Replace <Course_ID> with the specific course ID.
curl --location '<Base_URL>/loSummary?loId=course%3A<Course_ID>'
Sample response of the API call
{
"results": [
{
"instanceId": "14336686",
"courseId": "11312313",
"accountId": "44355",
"seatConsumed": 1,
"seatLimit": 1,
"waitlistLimit":1,
"waitlistCount": 1,
"seatAvailable": false,
"waitlistAvailable": false
}
],
"count": 1
}
NOTE
If a course has multiple instances, then you will get details for all the instances.
CDN JSON API for course details
The CDN JSON API allows you to retrieve the complete course information about a specific course.
Sample curl for course
Use the GET method to make the following request. Replace <CDN_path> with your base URL in the curl command below. You can find the <CDN_path> on the training data access connector page. Replace <Course_ID> with the specific course ID.
curl --location '<CDN_path_URL>/course/<Course_ID>.json'
Sample curl for learning path and certification
curl --location '<CDN_path_URL>/learningProgram/<LearningProgram_ID>.json'
curl --location '<CDN_path_URL>/ certification /<Certification_ID>.json'
Sample response of the API call
{
"data": {
"id": "course:11342313",
"type": "learningObject",
"attributes": {
"authorNames": [
"author1",
"author2"
],
"dateCreated": "2024-06-13T04:32:17.000Z",
"datePublished": "2024-06-13T04:32:51.000Z",
"dateUpdated": "2024-06-13T04:32:51.000Z",
"duration": 0,
"effectiveModifiedDate": "2024-06-13T04:32:51.000Z",
"effectivenessIndex": 0,
"enrollmentType": "Self Enroll",
"hasOptionalLoResources": false,
"hasPreview": false,
"isExternal": false,
"isMqaEnabled": false,
"isPrerequisiteEnforced": false,
"isSubLoOrderEnforced": false,
"loResourceCompletionCount": 1,
"loType": "course",
"moduleResetEnabled": false,
"state": "Published",
"tags": [
"course_tag"
],
"unenrollmentAllowed": true,
"localizedMetadata": [
{
"description": "",
"locale": "en-US",
"name": "vc coursse to check "
}
],
"rating": {
"averageRating": 0,
"ratingsCount": 0
}
},
"relationships": {
"authors": {
"data": [
{
"id": "13138897",
"type": "user"
}
]
},
"instances": {
"data": [
{
"id": "course:11332313_14336696",
"type": "learningObjectInstance"
}
]
},
"skills": {
"data": [
{
"id": "course:11332313_237719",
"type": "learningObjectSkill"
}
]
}
}
},
"included": [
{
"id": "237719",
"type": "skill",
"attributes": {
"name": "General",
"state": "Active"
},
"relationships": {
"levels": {
"data": [
{
"id": "237719_1",
"type": "skillLevel"
}
]
}
}
},
{
"id": "course:11312313",
"type": "learningObject",
"attributes": {
"authorNames": [
"m 41",
"rae"
],
"dateCreated": "2024-06-13T04:32:17.000Z",
"datePublished": "2024-06-13T04:32:51.000Z",
"dateUpdated": "2024-06-13T04:32:51.000Z",
"duration": 0,
"effectiveModifiedDate": "2024-06-13T04:32:51.000Z",
"effectivenessIndex": 0,
"enrollmentType": "Self Enroll",
"hasOptionalLoResources": false,
"hasPreview": false,
"isExternal": false,
"isMqaEnabled": false,
"isPrerequisiteEnforced": false,
"isSubLoOrderEnforced": false,
"loResourceCompletionCount": 1,
"loType": "course",
"moduleResetEnabled": false,
"state": "Published",
"tags": [
"course_tag"
],
"unenrollmentAllowed": true,
"localizedMetadata": [
{
"description": "",
"locale": "en-US",
"name": "course name "
}
],
"rating": {
"averageRating": 0,
"ratingsCount": 0
}
},
"relationships": {
"authors": {
"data": [
{
"id": "13128897",
"type": "user"
}
]
},
"instances": {
"data": [
{
"id": "course:11312313_14336696",
"type": "learningObjectInstance"
}
]
},
"skills": {
"data": [
{
"id": "course:11312313_237719",
"type": "learningObjectSkill"
}
]
}
}
},
{
"id": "course:11312313_14336696_12034506_0",
"type": "learningObjectResource",
"attributes": {
"externalReporting": false,
"isExpiredSubmission": false,
"loResourceType": "Content",
"multipleAttemptEnabled": false,
"previewEnabled": false,
"resourceType": "Virtual Classroom",
"submissionEnabled": false,
"localizedMetadata": [
{
"description": "",
"locale": "en-US",
"name": "vc session"
}
]
},
"relationships": {
"learningObject": {
"data": {
"id": "course:11312313",
"type": "learningObject"
}
},
"resources": {
"data": [
{
"id": "course:11312313_14336696_12034506_0_resource",
"type": "resource"
}
]
}
}
},
{
"id": "course:11312313_237719",
"type": "learningObjectSkill",
"attributes": {
"credits": 1,
"learningObjectId": "course:11312313"
},
"relationships": {
"skillLevel": {
"data": {
"id": "237719_1",
"type": "skillLevel"
}
}
}
},
{
"id": "13128897",
"type": "user",
"attributes": {
"avatarUrl": "https://abccontents.adobe.com/public/images/default_user_avatar.svg",
"binUserId": "1f8c01aa-7f58-42e9-bc40-11537eb6498d",
"email": "manjusha+41re@adobetest.com",
"enrollOnClick": false,
"gamificationEnabled": true,
"lastLoginDate": "2024-06-13T04:23:45.000Z",
"name": "m 41",
"pointsEarned": 0,
"pointsRedeemed": 0,
"preferredResolution": "AUTO",
"profile": "admin",
"roles": [
"Learner",
"Admin",
"Author",
"Instructor",
"Integration Admin"
],
"state": "ACTIVE",
"userType": "Internal"
},
"relationships": {
"account": {
"data": {
"id": "44355",
"type": "account"
}
}
}
},
{
"id": "course:11312313_14336696_12034506_0_resource",
"type": "resource",
"attributes": {
"avatarUrls": [
"https://abccontents.adobe.com/public/images/default_user_avatar.svg"
],
"completionDeadline": "2024-06-18T20:30:00.000Z",
"contentType": "Virtual Classroom",
"dateStart": "2024-06-18T19:30:00.000Z",
"desiredDuration": 3600,
"hasQuiz": false,
"hasToc": false,
"instructorNames": [
"instructor1"
],
"isDefault": true,
"locale": "en-US",
"location": "http://google.com",
"name": "vc session",
"onlyQuiz": false,
"reportingType": "NONE"
}
},
{
"id": "course:11312313_14336696",
"type": "learningObjectInstance",
"attributes": {
"dateCreated": "2024-06-13T04:32:18.000Z",
"isDefault": true,
"isFlexible": false,
"state": "Active",
"localizedMetadata": [
{
"locale": "en-US",
"name": "Default Instance"
}
],
"seatConsumed": 0,
"waitlistCount": 0
},
"relationships": {
"learningObject": {
"data": {
"id": "course:11312313",
"type": "learningObject"
}
},
"loResources": {
"data": [
{
"id": "course:11312313_14336696_12034506_0",
"type": "learningObjectResource"
}
]
}
}
},
{
"id": "237719_1",
"type": "skillLevel",
"attributes": {
"level": "1",
"maxCredits": 1,
"name": "Level 1"
},
"relationships": {
"skill": {
"data": {
"id": "237719",
"type": "skill"
}
}
}
}
]
}
recommendation-more-help
d5e5961a-141b-4c77-820e-8453ddef913d