Skip to content
API Reference
/
catalog
/
catalog_invitations_program_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_invitations_program_retrieve

Request

API View for managing program invitations.

This endpoint allows querying, creating, and deleting program invitations for users.

Query/Request Parameters: For GET: program_key (str, optional): Filter by program key org (str, optional): Filter by platform organization email (str, optional): Filter by user email source (str, optional): Filter by invitation source active (bool, optional): Filter by active status sort (str, optional): Field to sort results by (default: '-id') metadata fields: Any additional parameters will be treated as metadata filters

For POST: program_key (str, required): The program to create an invitation for email (str, required): The email address to invite active (bool, optional): Whether the invitation is active metadata fields: Any additional parameters will be added as metadata

For DELETE: id (int, required): The ID of the invitation to delete org (str, required): The platform organization for verification

Methods: GET: Retrieve a paginated list of program invitations POST: Create a new program invitation DELETE: Remove a program invitation

Returns: GET: A paginated JSON response containing program invitations: { "count": 10, "next": "https://example.com/api/catalog/invitations/program/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "username", "email": "user@example.com", "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "source": "source", "redirect_to": "https://example.com", "expired": null, "active": true, "metadata": {}, "program_key": "org+program1" }, ... ] }

POST: A JSON response containing the created invitation: { "id": 123, "user_id": 456, "username": "username", "email": "user@example.com", "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "source": "source", "redirect_to": "https://example.com", "expired": null, "active": true, "metadata": {}, "program_key": "org+program1" }

DELETE: A success response with status 200

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 access this resource 404 Not Found: If the program or invitation doesn't exist 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForProgram permission
  • Read-only access for platform admins, full access for DM admins and program-specific admins
Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by active status

emailstringnon-empty

Filter by user email

orgstringnon-empty

Filter by platform organization

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

program_keystringnon-empty

Filter by program key

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/program/?active=true&email=string&org=string&page=0&page_size=0&program_key=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(ProgramInvitationDetail)required

List of program invitations

results[].​idintegerrequired

The unique identifier for the invitation

results[].​user_idinteger or nullrequired

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)required

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[].​program_keystringrequired

The program key associated with the invitation

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

catalog_invitations_program_create

Request

API View for managing program invitations.

This endpoint allows querying, creating, and deleting program invitations for users.

Query/Request Parameters: For GET: program_key (str, optional): Filter by program key org (str, optional): Filter by platform organization email (str, optional): Filter by user email source (str, optional): Filter by invitation source active (bool, optional): Filter by active status sort (str, optional): Field to sort results by (default: '-id') metadata fields: Any additional parameters will be treated as metadata filters

For POST: program_key (str, required): The program to create an invitation for email (str, required): The email address to invite active (bool, optional): Whether the invitation is active metadata fields: Any additional parameters will be added as metadata

For DELETE: id (int, required): The ID of the invitation to delete org (str, required): The platform organization for verification

Methods: GET: Retrieve a paginated list of program invitations POST: Create a new program invitation DELETE: Remove a program invitation

Returns: GET: A paginated JSON response containing program invitations: { "count": 10, "next": "https://example.com/api/catalog/invitations/program/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "username", "email": "user@example.com", "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "source": "source", "redirect_to": "https://example.com", "expired": null, "active": true, "metadata": {}, "program_key": "org+program1" }, ... ] }

POST: A JSON response containing the created invitation: { "id": 123, "user_id": 456, "username": "username", "email": "user@example.com", "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "source": "source", "redirect_to": "https://example.com", "expired": null, "active": true, "metadata": {}, "program_key": "org+program1" }

DELETE: A success response with status 200

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 access this resource 404 Not Found: If the program or invitation doesn't exist 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForProgram permission
  • Read-only access for platform admins, full access for DM admins and program-specific admins
Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by active status

emailstringnon-empty

Filter by user email

orgstringnon-empty

Filter by platform organization

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

program_keystringnon-empty

Filter by program key

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

Body
required
program_keystringrequired

The program to create an invitation for

emailstring(email)

The email address to invite

usernamestring

The username to invite

activeboolean

Whether the invitation is active

Default true
sourcestring

The source of the invitation

redirect_tostring(uri)

URL to redirect to after accepting the invitation

createdstring(date-time)

When the invitation was created

expiredstring(date-time)

When the invitation expires

metadataobject

Additional metadata for the invitation

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/program/?active=true&email=string&org=string&page=0&page_size=0&program_key=string&sort=-id&source=string&username=string&verbose=true' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "program_key": "string",
    "email": "user@example.com",
    "username": "string",
    "active": true,
    "source": "string",
    "redirect_to": "http://example.com",
    "created": "2019-08-24T14:15:22Z",
    "expired": "2019-08-24T14:15:22Z",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the invitation

user_idinteger or nullrequired

The ID of the user associated with the invitation

usernamestring or nullrequired

The username of the user associated with the invitation

emailstring or null(email)required

The email address associated with the invitation

createdstring(date-time)required

When the invitation was created

startedstring or null(date-time)required

When the invitation was started

expiredstring or null(date-time)required

When the invitation expires

sourcestring or nullrequired

The source of the invitation

redirect_tostring or null(uri)required

URL to redirect to after accepting the invitation

activebooleanrequired

Whether the invitation is active

metadataobjectrequired

Additional metadata for the invitation

metadata.​property name*anyadditional property
program_keystringrequired

The program key associated with the invitation

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "username": "string",
  "email": "user@example.com",
  "created": "2019-08-24T14:15:22Z",
  "started": "2019-08-24T14:15:22Z",
  "expired": "2019-08-24T14:15:22Z",
  "source": "string",
  "redirect_to": "http://example.com",
  "active": true,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "program_key": "string"
}

catalog_invitations_program_destroy

Request

Remove a program invitation: TBD

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by active status

emailstringnon-empty

Filter by user email

orgstringnon-empty

Filter by platform organization

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

program_keystringnon-empty

Filter by program key

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 DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/program/?active=true&email=string&org=string&page=0&page_size=0&program_key=string&sort=-id&source=string&username=string&verbose=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Invitation successfully deleted

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