Skip to content
API Reference
/
catalog
/
catalog_eligibility_courses_list

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

catalog_courses_destroy

Request

Remove a course from the database.

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

The unique identifier for the course to be deleted

orgstringnon-empty

Filter courses by their associated organization

slugstringnon-empty

Filter courses by their slug (case-insensitive)

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/courses/?course_id=string&org=string&slug=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Number of courses deleted

typeobjectrequired

Types of objects deleted

type.​property name*anyadditional property
Response
application/json
{
  "count": 0,
  "type": {
    "property1": null,
    "property2": null
  }
}

catalog_eligibility_courses_list

Request

List courses that a user is eligible for.

Security
PlatformApiKeyAuthentication
Query
orgstringnon-empty

Filter eligible courses by organization

querystringnon-empty

Search term to filter eligible courses

user_idstringnon-empty

User ID to check eligibility for

usernamestringnon-empty

Username to check eligibility for

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/eligibility/courses/?org=string&query=string&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
course_idstringread-onlyrequired

The edX course ID string for the course.

namestringread-onlyrequired

The display name of the course. (Should match edX)

slugstring or null^[-a-zA-Z0-9_]+$read-onlyrequired

An additional unique slug field. (Optional)

orgstring
]
Response
application/json
[
  {
    "course_id": "string",
    "name": "string",
    "slug": "string",
    "org": "string"
  }
]

catalog_eligibility_courses_check_retrieve

Request

Check whether a user is eligible to enroll in a specific course.

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

Course ID to check eligibility for

local_onlyboolean

Whether to check eligibility only within the local organization

orgstringnon-empty

Organization of the course

user_idstringnon-empty

User ID to check eligibility for

usernamestringnon-empty

Username to check eligibility for

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/eligibility/courses/check/?course_id=string&local_only=true&org=string&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
property name*anyadditional property
Response
application/json
{
  "property1": null,
  "property2": null
}

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com