Skip to content
API Reference
/
catalog
/
catalog_increment_create

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_increment_retrieve

Request

Retrieve auto increment information for a specific platform.

Security
PlatformApiKeyAuthentication
Query
keystringnon-empty

Platform key identifier

orgstringnon-empty

Platform organization identifier

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/increment/?key=string&org=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
course_numberintegerrequired

Current course auto-increment number

item_numberinteger

Current item auto-increment number

program_numberinteger

Current program auto-increment number

orgstringrequired

Platform organization

keystringrequired

Platform key

Response
application/json
{
  "course_number": 0,
  "item_number": 0,
  "program_number": 0,
  "org": "string",
  "key": "string"
}

catalog_increment_create

Request

Update auto increment information and retrieve a new ID for a specific platform.

Security
PlatformApiKeyAuthentication
Body
required
keystring

Platform key identifier

orgstring

Platform organization identifier

number_typestringrequired

Type of number requested (e.g., course, program, pathway)

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/increment/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "string",
    "org": "string",
    "number_type": "string"
  }'

Responses

Bodyapplication/json
integer
Response
application/json
0

catalog_invitations_course_retrieve

Request

Retrieve a paginated list of course invitations

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by active status

course_idstringnon-empty

Filter by course ID

emailstringnon-empty

Filter by user email

keystringnon-empty

Alternative filter by platform key

orgstringnon-empty

Alternative filter by platform organization

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

platform_keystringnon-empty

Filter by platform key

platform_orgstringnon-empty

Filter by platform organization

sortstringnon-empty

Field to sort results by

Default "-id"
sourcestringnon-empty

Filter by invitation source

usernamestringnon-empty

Filter by username

verboseboolean

Whether to include verbose output

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/course/?active=true&course_id=string&email=string&key=string&org=string&page=0&page_size=0&platform_key=string&platform_org=string&sort=-id&source=string&username=string&verbose=true' \
  -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(CourseInvitationDetail)required

List of course invitations

results[].​idintegerrequired

The unique identifier for the invitation

results[].​user_idinteger or null

The ID of the user associated with the invitation

results[].​usernamestring or nullrequired

The username of the user associated with the invitation

results[].​emailstring or null(email)required

The email address associated with the invitation

results[].​createdstring(date-time)

When the invitation was created

results[].​startedstring or null(date-time)required

When the invitation was started

results[].​expiredstring or null(date-time)required

When the invitation expires

results[].​sourcestring or nullrequired

The source of the invitation

results[].​redirect_tostring or null(uri)required

URL to redirect to after accepting the invitation

results[].​activebooleanrequired

Whether the invitation is active

results[].​metadataobjectrequired

Additional metadata for the invitation

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

The course ID associated with the invitation

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

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