Skip to content
API Reference
/
catalog
/
catalog_suggestions_program_manage_group_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_suggestions_program_manage_bulk_create

Request

API View for bulk creation of program suggestions.

This endpoint allows administrators to create multiple program suggestions at once.

Methods: POST: Create multiple program suggestions in bulk

Request Body: A JSON object containing:

  • platform_key (str, required): The platform for the suggestions
  • suggestion_data (array, required): Array of suggestion objects with:
    • program_key (str, required): The program key to suggest
    • user_id (str/int, required): The user to suggest the program to
    • accepted (bool, optional): Whether the suggestion is accepted
    • visible (bool, optional): Whether the suggestion is visible
    • metadata (dict, optional): Additional suggestion metadata

Returns: POST: A JSON response containing the results of the bulk operation: { "successes": 15, "error_codes": [] }

Error Responses: 400 Bad Request: If required parameters are missing or invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to create suggestions 500 Internal Server Error: If an unexpected error occurs during bulk creation

Access Control:

  • Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
  • Platform admins can create suggestions for their platform
  • Department admins can create suggestions for their departments
  • DM admins can create suggestions for all platforms
Security
PlatformApiKeyAuthentication
Body
required
platform_keystringrequired

The platform for the suggestions

platform_orgstring

The organization identifier for the platform

suggestion_dataArray of objectsrequired

List of suggestion data objects, each containing program_key, user_id, etc.

suggestion_data[].​property name*anyadditional property
department_modeboolean

Flag to ensure department admins can call the API

Default false
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/program/manage/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform_key": "string",
    "platform_org": "string",
    "suggestion_data": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "department_mode": false
  }'

Responses

Bodyapplication/json
successesintegerrequired

Number of successfully created suggestions

error_codesArray of stringsrequired

List of error codes for failed suggestions

Response
application/json
{
  "successes": 0,
  "error_codes": [
    "string"
  ]
}

catalog_suggestions_program_manage_group_retrieve

Request

API View for managing program group suggestions.

This endpoint allows administrators to view, create, and delete program suggestions for groups of users within a platform.

Query Parameters (GET): platform_key (str, required): The platform to retrieve group suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter group suggestions sort (str, optional): Field to sort results by (default: 'id') department_mode (bool, optional): Filter suggestions by department admin access page (int, optional): Page number for pagination page_size (int, optional): Number of items per page

Methods: GET: Retrieve a paginated list of program group suggestions for a platform POST: Create or update a program group suggestion DELETE: Remove a program group suggestion

Request Body (POST): A JSON object containing:

  • platform_key (str, required): The platform for the group suggestion
  • program_key (str, required): The program key to suggest
  • group_id (str/int, required): The group to suggest the program to
  • accepted (bool, optional): Whether the suggestion is accepted
  • visible (bool, optional): Whether the suggestion is visible
  • metadata (dict, optional): Additional suggestion metadata

Query Parameters (DELETE): suggestion_id (int, required): The ID of the group suggestion to delete

Returns: GET: A paginated JSON response containing program group suggestions: { "count": 5, "next": "https://example.com/api/catalog/suggestions/program/group/?page=2", "previous": null, "results": [ { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program", "user_count": 25 }, ... ] }

POST: A JSON response containing the created/updated group suggestion: { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program", "user_count": 25 }

DELETE: A success response with status 200

Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage group suggestions 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
  • Platform admins can manage group suggestions for their platform
  • Department admins can manage group suggestions for their departments
  • DM admins can manage all group suggestions
Security
PlatformApiKeyAuthentication
Query
department_modeboolean

Filter suggestions by department admin access

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve group suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter group suggestions

sortstringnon-empty

Field to sort results by

Default "id"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/program/manage/group/?department_mode=true&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Total number of results

next_pagestring or null(uri)required

URL for next page of results

previous_pagestring or null(uri)required

URL for previous page of results

resultsArray of objects(ProgramGroupSuggestionDetail)required

List of program group suggestions

results[].​idintegerrequired

The unique identifier for the group suggestion

results[].​group_idintegerrequired

The ID of the group receiving the suggestion

results[].​group_namestringrequired

The name of the group receiving the suggestion

results[].​platform_keystringrequired

The platform key associated with the suggestion

results[].​acceptedbooleanrequired

Whether the suggestion has been accepted

results[].​visiblebooleanrequired

Whether the suggestion is visible

results[].​createdstring(date-time)required

When the suggestion was created

results[].​modifiedstring(date-time)required

When the suggestion was last modified

results[].​metadataobjectrequired

Additional metadata for the suggestion

results[].​metadata.​property name*anyadditional property
results[].​program_keystringrequired

The program key being suggested

results[].​program_namestringrequired

The name of the program being suggested

results[].​user_countintegerrequired

Number of users in the group

Response
application/json
{
  "count": 0,
  "next_page": "http://example.com",
  "previous_page": "http://example.com",
  "results": [
    { … }
  ]
}

catalog_suggestions_program_manage_group_create

Request

API View for managing program group suggestions.

This endpoint allows administrators to view, create, and delete program suggestions for groups of users within a platform.

Query Parameters (GET): platform_key (str, required): The platform to retrieve group suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter group suggestions sort (str, optional): Field to sort results by (default: 'id') department_mode (bool, optional): Filter suggestions by department admin access page (int, optional): Page number for pagination page_size (int, optional): Number of items per page

Methods: GET: Retrieve a paginated list of program group suggestions for a platform POST: Create or update a program group suggestion DELETE: Remove a program group suggestion

Request Body (POST): A JSON object containing:

  • platform_key (str, required): The platform for the group suggestion
  • program_key (str, required): The program key to suggest
  • group_id (str/int, required): The group to suggest the program to
  • accepted (bool, optional): Whether the suggestion is accepted
  • visible (bool, optional): Whether the suggestion is visible
  • metadata (dict, optional): Additional suggestion metadata

Query Parameters (DELETE): suggestion_id (int, required): The ID of the group suggestion to delete

Returns: GET: A paginated JSON response containing program group suggestions: { "count": 5, "next": "https://example.com/api/catalog/suggestions/program/group/?page=2", "previous": null, "results": [ { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program", "user_count": 25 }, ... ] }

POST: A JSON response containing the created/updated group suggestion: { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program", "user_count": 25 }

DELETE: A success response with status 200

Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage group suggestions 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
  • Platform admins can manage group suggestions for their platform
  • Department admins can manage group suggestions for their departments
  • DM admins can manage all group suggestions
Security
PlatformApiKeyAuthentication
Query
department_modeboolean

Filter suggestions by department admin access

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve group suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter group suggestions

sortstringnon-empty

Field to sort results by

Default "id"
Body
required
platform_keystringrequired

The platform for the group suggestion

platform_orgstring

The organization identifier for the platform

program_keystringrequired

The program key to suggest

group_idintegerrequired

The group to suggest the program to

acceptedboolean

Whether the suggestion is accepted

Default false
visibleboolean

Whether the suggestion is visible

Default true
metadataobject

Additional suggestion metadata

department_modeboolean

Flag to ensure department admins can call the API

Default false
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/program/manage/group/?department_mode=true&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform_key": "string",
    "platform_org": "string",
    "program_key": "string",
    "group_id": 0,
    "accepted": false,
    "visible": true,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "department_mode": false
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the group suggestion

group_idintegerrequired

The ID of the group receiving the suggestion

group_namestringrequired

The name of the group receiving the suggestion

platform_keystringrequired

The platform key associated with the suggestion

acceptedbooleanrequired

Whether the suggestion has been accepted

visiblebooleanrequired

Whether the suggestion is visible

createdstring(date-time)required

When the suggestion was created

modifiedstring(date-time)required

When the suggestion was last modified

metadataobjectrequired

Additional metadata for the suggestion

metadata.​property name*anyadditional property
program_keystringrequired

The program key being suggested

program_namestringrequired

The name of the program being suggested

user_countintegerrequired

Number of users in the group

Response
application/json
{
  "id": 0,
  "group_id": 0,
  "group_name": "string",
  "platform_key": "string",
  "accepted": true,
  "visible": true,
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "program_key": "string",
  "program_name": "string",
  "user_count": 0
}

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