Skip to content
API Reference
/
catalog
/
catalog_enrollment_courses_search_retrieve

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_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
}

catalog_enrollment_courses_search_retrieve

Request

API View for searching course enrollments.

This endpoint allows searching for course enrollments based on various filters such as user ID, username, email, course ID, slug, organization, and platform key. Results are paginated and include detailed enrollment information.

Query Parameters: user_id (str, optional): Filter enrollments by user ID username (str, optional): Filter enrollments by username email (str, optional): Filter enrollments by user email course_id (str, optional): Filter enrollments by course ID slug (str, optional): Filter enrollments by course slug org (str, optional): Filter enrollments by organization platform_key (str, optional): Filter enrollments by platform key course_name (str, optional): Filter enrollments by course name (partial match) include_default_platform (bool, optional): Include enrollments from default platform sort (str, optional): Field to sort results by (default: '-id') page (int, optional): Page number for pagination page_size (int, optional): Number of items per page

Methods: GET: Search for course enrollments with filtering and pagination

Returns: GET: A paginated JSON response containing course enrollments: { "count": 42, "next": "https://api.example.com/api/catalog/enrollment/courses/search/?page=2", "previous": null, "results": [ { "user_id": 123, "username": "student1", "email": "student1@example.com", "course_id": "course-v1:org+course+run", "active": true, "created": "2023-01-15T10:30:00Z", "started": "2023-01-15T10:30:00Z", "ended": null, "expired": null, "metadata": {}, "name": "John Doe", "course_name": "Introduction to Data Science" }, ... ] }

Error Responses: 400 Bad Request: If required parameters are missing or if enrollment search fails 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin, IsEdxUserReadOnly, or IsPlatformAdminOfUserReadOnly permission
  • Users can view their own enrollments
  • Platform admins can view enrollments for users in their platform
  • DM admins can view all enrollments
Security
PlatformApiKeyAuthentication
Query
course_idstringnon-empty

Filter enrollments by course ID

course_namestringnon-empty

Filter enrollments by course name (partial match)

emailstringnon-empty

Filter enrollments by user email

include_default_platformboolean

Include enrollments from default platform

orgstringnon-empty

Filter enrollments by organization

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Filter enrollments by platform key

slugstringnon-empty

Filter enrollments by course slug

sortstringnon-empty

Field to sort results by

Default "-id"
user_idstringnon-empty

Filter enrollments by user ID

usernamestringnon-empty

Filter enrollments by username

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/courses/search/?course_id=string&course_name=string&email=string&include_default_platform=true&org=string&page=0&page_size=0&platform_key=string&slug=string&sort=-id&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
user_idintegerrequired

User ID associated with the enrollment

usernamestringrequired

Username associated with the enrollment

emailstringrequired

Email of the user

course_idstringrequired

Course ID associated with the enrollment

activebooleanrequired

Whether the enrollment is active

createdstring(date-time)required

Date when enrollment began/activated

startedstring or null(date-time)required

Date when enrollment started

endedstring or null(date-time)required

Date when enrollment ended/deactivated

expiredstring or null(date-time)required

Date when enrollment expires

metadataany or nullrequired

Enrollment specific metadata

namestring or nullrequired

Full name of the user

course_namestringrequired

Name of the course

Response
application/json
{
  "user_id": 0,
  "username": "string",
  "email": "string",
  "course_id": "string",
  "active": true,
  "created": "2019-08-24T14:15:22Z",
  "started": "2019-08-24T14:15:22Z",
  "ended": "2019-08-24T14:15:22Z",
  "expired": "2019-08-24T14:15:22Z",
  "metadata": null,
  "name": "string",
  "course_name": "string"
}

catalog_enrollment_pathways_retrieve

Request

Search pathway enrollments. Requires user_id or username and pathway_id or slug.

Security
PlatformApiKeyAuthentication
Query
activeboolean

Whether the enrollment should be active

Default true
include_default_platformboolean

Include enrollments from default platform

include_metadataboolean

Include metadata in the response

Default true
orgstringnon-empty

Organization for the pathway

pathway_idstringnon-empty

Pathway ID for enrollment

pathway_keystringnon-empty

Pathway key for enrollment

pathway_uuidstringnon-empty

Pathway UUID for enrollment

platform_keystringnon-empty

Platform key for the pathway

slugstringnon-empty

Pathway slug for enrollment

user_idstringnon-empty

User ID for enrollment

usernamestringnon-empty

Username for enrollment

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/pathways/?active=true&include_default_platform=true&include_metadata=true&org=string&pathway_id=string&pathway_key=string&pathway_uuid=string&platform_key=string&slug=string&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
user_idinteger
usernamestring
pathway_idstring
pathway_uuidstring
platform_keystring
orgstring
namestring
slugstring
createdstring or null(date-time)

Date when enrollment began/activated

endedstring or null(date-time)read-onlyrequired

Date when enrollment ended/deactivated

activeboolean

Whether the enrollment is active

metadataany or null
Response
application/json
{
  "user_id": 0,
  "username": "string",
  "pathway_id": "string",
  "pathway_uuid": "string",
  "platform_key": "string",
  "org": "string",
  "name": "string",
  "slug": "string",
  "created": "2019-08-24T14:15:22Z",
  "ended": "2019-08-24T14:15:22Z",
  "active": true,
  "metadata": 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