LearnUpon API

https://docs.learnupon.com/api/
Admin
LearnUpon API is a comprehensive REST API for managing users, courses, enrollments, live learning...
Tokens:143,139
Snippets:587
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### cURL Command-Line Examples for LearnUpon API

Source: https://docs.learnupon.com/api/index

Demonstrates how to interact with the LearnUpon API using cURL commands. These examples cover various user management operations like listing users, creating users, and searching by email or username. Note the advice for Windows users regarding quote escaping.

```bash
curl https://your_domain.learnupon.com/api/v1/users
curl https://your_domain.learnupon.com/api/v1/users?version_id=1.1
curl https://your_domain.learnupon.com/api/v1/users?version_id=1.2
curl https://your_domain.learnupon.com/api/v1/users/{id}
curl https://your_domain.learnupon.com/api/v1/users/search?email=test@example.com
curl https://your_domain.learnupon.com/api/v1/users/search?username=testuser
curl https://your_domain.learnupon.com/api/v1/users/instructor_users
curl https://your_domain.learnupon.com/api/v1/users/customuserdata
curl -X POST https://your_domain.learnupon.com/api/v1/users -d '{"email":"test@example.com"}'
curl -X PUT https://your_domain.learnupon.com/api/v1/users -d '{"id": 123, "email":"updated@example.com"}'
curl -X DELETE https://your_domain.learnupon.com/api/v1/users/{id}
```

--------------------------------

### Search Legacy ILTs by Start Date (GET Request)

Source: https://docs.learnupon.com/api/index

This endpoint allows you to find legacy Instructor-led trainings (ILTs) that are scheduled to start on a particular date.

```http
GET /ilts/search?start_date=
```

--------------------------------

### Clone Course with GUID (curl)

Source: https://docs.learnupon.com/api/index

This example shows how to clone a course to the same location more than once by utilizing the GUID obtained from a previous cloning operation. This prevents duplicate requests and ensures the cloning process is managed correctly.

```curl
curl -X POST -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c -d
 '{"clone_to_portal_id" : "5127", "course_id" : "12364"}'  
 https://yourdomain.learnupon.com/api/v1/courses/clone?guid=9ezjl8Ig_J9WeZEcN6RBTw
```

--------------------------------

### Clone Module (Second Attempt with GUID) - cURL

Source: https://docs.learnupon.com/api/index

This cURL command shows how to clone a module to the same course more than once by including the 'guid' obtained from a previous cloning attempt.

```shell
curl -X POST -H "Content-Type: application/json" --user 93a306ad8fff2fe3dbd1:d670237770e52266234ecd45678bce -d
'{"source_course_id":"12345", "target_course_id": "67890", "module_id": "87654" }'
https://yourdomain.learnupon.com/api/v1/modules/clone?guid=bIDh29Hd5o_r1UDq-Jvx7g
```

--------------------------------

### Create User with Basic Information via cURL

Source: https://docs.learnupon.com/api/index

This cURL command illustrates how to create a new user in LearnUpon by sending a POST request with essential user details such as last name, first name, email, password, and language.

```bash
curl -X POST -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c -d
'{"User": {"last_name" : "Upon", "first_name" : "Learn", "email" : "learnuponapi@samplelearningco.com",
"password" : "password1", "language" : "en" }}'
https://yourdomain.learnupon.com/api/v1/users
```

--------------------------------

### GET /api/v1/timezones

Source: https://docs.learnupon.com/api/index

Retrieves a list of timezones supported by your LearnUpon portal, useful for setting session start and end times accurately.

```APIDOC
## GET /api/v1/timezones

### Description
This method returns a list of timezones available in your portal. See the list of supported timezones in Appendix: Timezone names.

### Method
GET

### Endpoint
/api/v1/timezones

### Parameters
This method has no additional parameters.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the session timezone.
- **name** (string) - Description which appears in the application.

#### Response Example
```json
[
  {
    "id": "America/New_York",
    "name": "(GMT-05:00) Eastern Time (US & Canada)"
  }
]
```
```

--------------------------------

### POST /api/v1/portals

Source: https://docs.learnupon.com/api/index

Creates a new portal with specified subdomain, title, and optional branding and licensing settings. It can also copy settings from a parent portal.

```APIDOC
## POST /api/v1/portals

### Description
Creates a new portal with specified subdomain, title, and optional branding and licensing settings. It can also copy settings from a parent portal.

### Method
POST

### Endpoint
https://yourdomain.learnupon.com/api/v1/portals

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **Portal** (object) - Required - Contains portal configuration details.
  - **subdomain** (string) - Required - Subdomain of your portal.
  - **title** (string) - Required - Title of the new portal.
  - **description** (string) - Optional - Description for the new portal.
  - **logo_image_url** (string) - Optional - URL of the logo image of the new portal.
  - **banner_image_url** (string) - Optional - URL of the banner image of the new portal.
  - **store_banner_image_url** (string) - Optional - URL for an image, to use as store banner image of the new portal.
  - **favicon_image_url** (string) - Optional - URL of the favicon image of the new portal.
  - **header_color** (string) - Optional - Hexadecimal code for the portal's header color, default (#419BBD).
  - **navigation_color** (string) - Optional - Hexadecimal code for the portal's tab navigation color, default (#256188).
  - **number_licenses_purchased** (integer) - Optional - For portal licensing: you can specify the number of purchased licenses for a given portal. Setting this enables the license model.
  - **copy_from_parent** (boolean) - Optional - If set to `true`, the new portal copies many settings from the top-level portal. If SQSSO is set up on the top-level portal, this call generates a new SQSSO secret key.
  - **allow_course_authoring** (boolean) - Optional - Permissions: indicates if admins in a sub-portal can edit courses in that portal. Default is `true`.

### Request Example
```json
{
  "Portal": {
    "subdomain": "clientx",
    "title": "New Title",
    "description": "New description",
    "logo_image_url": "Image url",
    "banner_image_url": "Image url",
    "store_banner_image_url": "Image url",
    "favicon_image_url": "Image url",
    "header_color": "#419BBD",
    "navigation_color": "#256188"
  }
}
```

### Response
#### Success Response (200)
- **id** (integer) - Unique numeric identifier of the new portal.
- **client_sqsso_secret_key** (string) - If `copy_from_parent` is `true` and SQSSO was enabled on the top-level portal, the API returns a new Secret Key for the new portal's SQSSO. Otherwise, this element will not be present.

#### Response Example
```json
{
  "id": 12345,
  "client_sqsso_secret_key": "your_sso_secret_key"
}
```
```

--------------------------------

### Create a New Portal (curl)

Source: https://docs.learnupon.com/api/index

This snippet demonstrates how to create a new portal using the LearnUpon API with a POST request. It includes mandatory and optional parameters for portal configuration, such as subdomain, title, description, and branding elements. The API key for authentication is provided in the `--user` flag.

```curl
curl -X POST -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c -d '{"Portal" : { "subdomain": "clientx", "title" : "New Title", "description" : "New description", "logo_image_url" : "Image url", "banner_image_url" : "Image url", "store_banner_image_url" : "Image url", "favicon_image_url" : "Image url", "header_color" : "#419BBD", "navigation_color" : "#256188" }}' https://yourdomain.learnupon.com/api/v1/portals
```

--------------------------------

### Search Legacy ILTs by Start and End Dates

Source: https://docs.learnupon.com/api/index

This example shows how to find legacy ILT sessions within a specified date range. It utilizes the 'start_date' and 'end_date' parameters. The output lists ILTs scheduled between the provided dates.

```curl
curl -X GET -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c
https://yourdomain.learnupon.com/api/v1/ilts/search?start_date=2021-01-01&end_date=2021-01-10
```

--------------------------------

### GET /api/v1/leaderboard

Source: https://docs.learnupon.com/api/index

Retrieves leaderboard data for the portal. This endpoint can be filtered by user ID or group ID to get specific leaderboard results.

```APIDOC
## GET /api/v1/leaderboard

### Description
Searches for and lists leaderboard data for the portal. Can be filtered by user ID or group ID.

### Method
GET

### Endpoint
/api/v1/leaderboard

### Parameters
#### Query Parameters
- **user_id** (integer) - Optional - Unique numeric identifier for a specified user.
- **group_id** (integer) - Optional - Unique numeric identifier for a specific group.
- **points_over** (integer) - Optional - Minimum number of points.
- **points_under** (integer) - Optional - Maximum number of points.
- **date_from** (date/time) - Optional - Starting date/time for a query.
- **date_to** (date/time) - Optional - Ending date/time for a query.
- **level_name** (string) - Optional - Name of a particular level, for filtering users.

#### Request Body
- **(No request body documented)**

### Request Example

**Get all leaderboards:**
```bash
curl -X GET -H "Content-Type: application/json" --user <api_key>:<api_secret> https://yourdomain.learnupon.com/api/v1/leaderboard
```

**Get leaderboard by user ID:**
```bash
curl -X GET -H "Content-Type: application/json" --user <api_key>:<api_secret> https://yourdomain.learnupon.com/api/v1/leaderboard?user_id=1234
```

**Get leaderboard by group ID:**
```bash
curl -X GET -H "Content-Type: application/json" --user <api_key>:<api_secret> https://yourdomain.learnupon.com/api/v1/leaderboard?group_id=123
```

### Response
#### Success Response (200)
- **user_id** (integer) - Unique numeric identifier for the user on the leaderboard.
- **login** (string) - Username or email address of the user.
- **name** (string) - Display name of the user on the leaderboard.
- **position** (integer) - Position of the user on the leaderboard.
- **level** (string) - If levels are enabled: name of the level the user is on.
- **total_points** (integer) - Total gamification points of the user on the leaderboard.
- **total_badges** (integer) - Total count of badges for the user on the leaderboard.

#### Response Example
```json
[
  {
    "user_id": 123,
    "login": "john.doe@example.com",
    "name": "John Doe",
    "position": 1,
    "level": "Beginner",
    "total_points": 500,
    "total_badges": 5
  }
]
```
```

--------------------------------

### Create User with Manager Permissions via cURL

Source: https://docs.learnupon.com/api/index

This cURL command shows how to create a new user with specific permissions, including manager and instructor roles, by setting the `user_type` and `can_act_as_instructor` parameters in the JSON payload.

```bash
curl -X POST -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c -d
'{"User": {"last_name" : "Upon", "first_name" : "Learn", "email" : "learnuponapi@luptest.com", "password" : "password1", "language" : "en", "user_type": "manager",  "can_act_as_instructor" : "true" }}' https://yourdomain.learnupon.com/api/v1/users
```

--------------------------------

### Modules API

Source: https://docs.learnupon.com/api/index

Endpoints for managing modules, including searching, adding video/audio modules, and cloning.

```APIDOC
## GET /modules

### Description
Searches for modules with optional parameters.

### Method
GET

### Endpoint
/modules

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter modules by status (e.g., 'active', 'draft').
- **type** (string) - Optional - Filter modules by type (e.g., 'video', 'audio', 'scorm').

### Response
#### Success Response (200)
- **modules** (array) - A list of module objects.
  - **id** (integer) - Module ID.
  - **name** (string) - Module name.
  - **type** (string) - Module type.

#### Response Example
```json
{
  "modules": [
    {
      "id": 101,
      "name": "Introduction to API",
      "type": "video"
    }
  ]
}
```

## POST /modules/video_audio

### Description
Adds a video or audio module.

### Method
POST

### Endpoint
/modules/video_audio

### Parameters
#### Request Body
- **name** (string) - Required - The name of the module.
- **type** (string) - Required - The type of module ('video' or 'audio').
- **source_url** (string) - Required - The URL of the video or audio file.
- **duration_seconds** (integer) - Optional - The duration of the media in seconds.

### Request Example
```json
{
  "name": "Welcome Video",
  "type": "video",
  "source_url": "http://example.com/video.mp4",
  "duration_seconds": 120
}
```

### Response
#### Success Response (200)
- **module_id** (integer) - The ID of the newly created module.

#### Response Example
```json
{
  "module_id": 303
}
```

## POST /modules/clone

### Description
Clones an existing module.

### Method
POST

### Endpoint
/modules/clone

### Parameters
#### Request Body
- **module_id** (integer) - Required - The ID of the module to clone.
- **new_module_name** (string) - Optional - The name for the new cloned module.

### Request Example
```json
{
  "module_id": 303,
  "new_module_name": "Cloned Module"
}
```

### Response
#### Success Response (200)
- **new_module_id** (integer) - The ID of the newly cloned module.

#### Response Example
```json
{
  "new_module_id": 404
}
```
```

--------------------------------

### PUT /api/v1/portals/{id}

Source: https://docs.learnupon.com/api/index

Updates an existing portal's settings, including subdomain, title, description, and branding. Title and subdomain cannot be left blank.

```APIDOC
## PUT /api/v1/portals/{id}

### Description
Updates an existing portal's settings, including subdomain, title, description, and branding. Title and subdomain cannot be left blank.

### Method
PUT

### Endpoint
https://yourdomain.learnupon.com/api/v1/portals/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Unique numeric identifier for the portal you are updating.

#### Query Parameters
None

#### Request Body
- **Portal** (object) - Required - Contains portal configuration details. Fields not included will remain unchanged.
  - **subdomain** (string) - Required - Subdomain of your portal. Cannot be blank.
  - **title** (string) - Required - Title of the portal. Cannot be blank.
  - **description** (string) - Optional - Description for the portal.
  - **logo_image_url** (string) - Optional - URL of the logo image of the portal.
  - **banner_image_url** (string) - Optional - URL of the banner image of the portal.
  - **store_banner_image_url** (string) - Optional - URL for an image, to use as store banner image of the portal.
  - **favicon_image_url** (string) - Optional - URL of the favicon image of the portal.
  - **header_color** (string) - Optional - Hexadecimal code for the portal's header color.
  - **navigation_color** (string) - Optional - Hexadecimal code for the portal's tab navigation color.

### Request Example
```json
{
  "Portal": {
    "subdomain": "clienty",
    "title": "Updated Title",
    "description": "Updated description",
    "logo_image_url": "Image url",
    "banner_image_url": "Image url",
    "store_banner_image_url": "Image url",
    "favicon_image_url": "Image url",
    "header_color": "#419BBD",
    "navigation_color": "#256188"
  }
}
```

### Response
#### Success Response (200)
- **id** (integer) - Unique numeric identifier of the updated portal.

#### Response Example
```json
{
  "id": 12345
}
```
```

--------------------------------

### GET /api/v1/users/instructor_users

Source: https://docs.learnupon.com/api/index

Retrieves a list of all users with the 'instructor' user type.

```APIDOC
## GET /api/v1/users/instructor_users

### Description
Retrieves a list of all users with the 'instructor' user type.

### Method
GET

### Endpoint
/api/v1/users/instructor_users

### Request Example
```json
{
  "example": "curl -X GET -H \"Content-Type: application/json\" --user <api_key> https://yourdomain.learnupon.com/api/v1/users/instructor_users"
}
```

### Response
#### Success Response (200)
- **instructor_users** (object) - An object containing a list of instructor users.

#### Response Example
```json
{
  "example": "{\"instructor_users\":[{\"id\":291141,\"username\":\"\",\"email\":\"demouser1@learnupontest.com\",\"first_name\":\"Berengar\",\"last_name\":\"Hesse\",\"instructor_pm_id\":1475833,\"user_type\":\"instructor\"}]}"
}
```
```

--------------------------------

### Search Resources - cURL

Source: https://docs.learnupon.com/api/index

This cURL command demonstrates how to search for and retrieve all resources within a LearnUpon portal. It requires authentication credentials.

```shell
curl -X GET -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c -d
https://yourdomain.learnupon.com/api/v1/resources
```

--------------------------------

### GET /api/v1/users/{user_id}

Source: https://docs.learnupon.com/api/index

Retrieves details for a specific user by their user ID.

```APIDOC
## GET /api/v1/users/{user_id}

### Description
Retrieves details for a specific user by their user ID.

### Method
GET

### Endpoint
/api/v1/users/{user_id}

#### Path Parameters
- **user_id** (string) - Required - The unique identifier of the user.

### Request Example
```json
{
  "example": "curl -X GET -H \"Content-Type: application/json\" --user <api_key> https://yourdomain.learnupon.com/api/v1/users/123123"
}
```

### Response
#### Success Response (200)
- **user** (object) - An object containing the user's details.

#### Response Example
```json
{
  "example": "{\"user\":[{\"id\":123123,\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane.doe@example.com\"}]}"
}
```
```

--------------------------------

### Creating a User via API

Source: https://docs.learnupon.com/api/index

Example of creating a new user via the LearnUpon API using a POST request. A minimum of either 'email' or 'username' is required in the JSON payload.

```json
{
  "email": "newuser@example.com",
  "first_name": "New",
  "last_name": "User"
}
```

--------------------------------

### Certificate Assignment Confirmation

Source: https://docs.learnupon.com/api/index

Example of a successful response when a certificate is added to a learning path.

```json
{
    "message": "Success"
}
```

--------------------------------

### GET /api/v1/users/search

Source: https://docs.learnupon.com/api/index

Searches for users by email or username. At least one of these parameters must be provided.

```APIDOC
## GET /api/v1/users/search

### Description
Searches for users by email or username. At least one of these parameters must be provided.

### Method
GET

### Endpoint
/api/v1/users/search

#### Query Parameters
- **email** (string) - Required - The email address of the user to search for.
- **username** (string) - Required - The username of the user to search for.

### Request Example
```json
{
  "example": "curl -X GET -H \"Content-Type: application/json\" --user <api_key> https://yourdomain.learnupon.com/api/v1/users/search?email=learnuponapi@samplelearningco.com"
}
```

### Response
#### Success Response (200)
- **user** (object) - An object containing a list of users matching the search criteria.

#### Response Example
```json
{
  "example": "{\"user\":[{\"id\":662,\"first_name\":\"Learn\",\"last_name\":\"Upon\",\"email\":\"learnuponapi@samplelearningco.com\",\"created_at\":\"2012-12-18T15:30:09Z\", \"locale\" : \"de\" }]}"
}
```
```

--------------------------------

### Clone Module (First Attempt) - cURL

Source: https://docs.learnupon.com/api/index

This cURL command demonstrates the initial attempt to clone a module from a source course to a target course. The first attempt does not return any attributes.

```shell
curl -X POST -H "Content-Type: application/json" --user 93a306ad8fff2fe3dbd1:d670237770e52266234ecd45678bce -d
'{"source_course_id":"12345", "target_course_id": "67890", "module_id": "87654" }'
https://yourdomain.learnupon.com/api/v1/modules/clone
```

--------------------------------

### GET /api/v1/users

Source: https://docs.learnupon.com/api/index

Retrieves a list of all users on the portal. This endpoint can be filtered using query parameters.

```APIDOC
## GET /api/v1/users

### Description
Retrieves a list of all users on the portal. This endpoint can be filtered using query parameters.

### Method
GET

### Endpoint
/api/v1/users

#### Query Parameters
- **version_id** (string) - Optional - Use `1.1` to include `updated_at` attribute, or `1.2` to include `timezone_id` attribute.
- **login_enabled** (boolean) - Optional - Set to `true` to return enabled users only, set to `false` to return disabled users only.

### Request Example
```json
{
  "example": "curl -X GET -H \"Content-Type: application/json\" --user <api_key> https://yourdomain.learnupon.com/api/v1/users?version_id=1.1"
}
```

### Response
#### Success Response (200)
- **user** (object) - An object containing the list of users.
- **customDataFieldDefintions** (object) - An object containing custom user data fields if defined by the portal admin.

#### Response Example
```json
{
  "example": "{\"user\":[{\"id\":123,\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john.doe@example.com\",\"created_at\":\"2023-01-01T10:00:00Z\"}]}"
}
```
```

--------------------------------

### Create Legacy ILT Classroom Session

Source: https://docs.learnupon.com/api/index

This cURL command creates a new legacy ILT classroom session. It requires course ID and component details including session type, title, description, timezone, start/end times, and capacity. Optional parameters include location ID and tags.

```bash
curl -X POST -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c \
{
    "course_id": 48122,
    "component": {
        "session_type": "classroom",
        "title": "LearnUpon University  Hawaii session",
        "description": "<p>Unlock the power of learning with LearnUpon LMS</p>\r\n",
        "tags": "Classroom, LearnUpon,",
        "timezone_id": "Hawaii",
        "location_id": 2345,
        "start_at": "2020-12-29T09:00:00",
        "end_at": "2020-12-29T09:10:00",
        "max_capacity": 25
    }
} \
https://yourdomain.learnupon.com/api/v1/components/ilt
```

```json
{
    "id": 105
}
```

--------------------------------

### GET /api/v1/locations

Source: https://docs.learnupon.com/api/index

Retrieves a list of locations available in your portal, which can be used for scheduling in-person training sessions.

```APIDOC
## GET /api/v1/locations

### Description
This method returns the list of locations available in your portal. Session Locations is an optional course setting, for in-person training. To add a location to your session in the API call, you need the location `id` provided by this call.

### Method
GET

### Endpoint
/api/v1/locations

### Parameters
This method has no additional parameters.

### Response
#### Success Response (200)
- **id** (integer) - Unique numeric identifier for the location.
- **title** (string) - Name of the location of the session.
- **address1** (string) - First line of physical address.
- **address2** (string) - Second line of physical address.
- **address3** (string) - Third line of physical address.
- **timezone** (string) - Refers to UTC time zone.
- **country_code** (string) - Country code, e.g., "IE" for Ireland, "US" for United States, "GB" for Great Britain.
- **notes** (string) - Free text field for details about the location.

#### Response Example
```json
[
  {
    "id": 1,
    "title": "Conference Room A",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "address3": null,
    "timezone": "America/New_York",
    "country_code": "US",
    "notes": "Includes projector and whiteboard."
  }
]
```
```

--------------------------------

### Create Audio or Video Module

Source: https://docs.learnupon.com/api/index

This endpoint allows you to create a new module in LearnUpon, specifically for audio or video content. You must provide either a video_url or an audio_url.

```APIDOC
## POST /api/v1/modules

### Description
Create a new module with audio or video content.

### Method
POST

### Endpoint
https://yourdomain.learnupon.com/api/v1/modules

### Parameters
#### Query Parameters
None

#### Request Body
- **module_title** (string) - Required - Title of the new module.
- **video_url** (string) - Required (or audio_url) - Fully qualified URL to the video file.
- **audio_url** (string) - Required (or video_url) - Fully qualified URL to the audio file.
- **tags** (string) - Optional - A comma-separated list of tags for the module.

### Request Example
```json
{
  "module_title": "Api video module",
  "video_url": "https://url_to_the_video"
}
```

### Response
#### Success Response (201 Created)
- **id** (integer) - The unique identifier for the created module.
- **title** (string) - The title of the created module.
- **component_type** (string) - The type of the module (e.g., 'page', 'video').

#### Response Example
```json
{
  "id": 123,
  "title": "Api video module",
  "component_type": "video"
}
```
```

--------------------------------

### Create Learning Path Enrollment (curl)

Source: https://docs.learnupon.com/api/index

This snippet demonstrates how to create a new learning path enrollment using a cURL command. It requires authentication and specifies the user's email and the learning path's name in the request body. The API endpoint and required headers are also shown.

```bash
curl -X POST -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c -d
 '{"Enrollment": { "email" : "learnuponapi@samplelearningco.com", "lp_name" : "Hello API"}}' https://yourdomain.learnupon.com/api/v1/learning_path_enrollments
```

--------------------------------

### GET /certifications

Source: https://docs.learnupon.com/api/index

Retrieves a list of all certificates available on the LearnUpon portal. These certificates can then be associated with courses or learning paths.

```APIDOC
## GET /certifications

### Description
Searches for and lists all certificates available on the portal. These certificates can be assigned to courses or learning paths.

### Method
GET

### Endpoint
/certifications

### Query Parameters
None

### Request Example
```json
curl -X GET -H "Content-Type: application/json" --user YOUR_API_KEY:YOUR_API_SECRET
https://yourdomain.learnupon.com/api/v1/certifications
```

### Response
#### Success Response (200)
- **certifications** (array) - An array of certificate objects.
  - **id** (integer) - The unique identifier for the certificate.
  - **name** (string) - The name of the certificate.
  - **created_at** (date/time) - The date and time the certificate was created.
  - **updated_at** (date/time) - The date and time the certificate was last updated.

#### Response Example
```json
{
    "certifications": [
        {
            "id": 1,
            "name": "Certificate of Completion",
            "created_at": "2023-01-15T10:00:00.000Z",
            "updated_at": "2023-01-15T10:00:00.000Z"
        }
    ]
}
```
```

--------------------------------

### GET /api/v1/webinars

Source: https://docs.learnupon.com/api/index

Retrieves all webinars in your portal that are associated with a specific `webinar_connection_id`. This allows you to filter webinars by integration provider.

```APIDOC
## GET /api/v1/webinars

### Description
This method returns the all the webinars in your portal which use a specific `webinar_connection_id`. For example: if you enter a query with the `webinar_connection_id` for WebEx, the API returns all the webinars which use the WebEx integration in your portal. This same search does not show you webinars which use Zoom or Adobe Connect in your portal.

### Method
GET

### Endpoint
/api/v1/webinars

### Parameters
#### Query Parameters
- **webinar_connection_id** (integer) - Required - Unique identifier for the 3rd party webinar provider on your portal.

### Request Example
```bash
curl -X GET -H "Content-Type: application/json" --user <api_key>
https://yourdomain.learnupon.com/api/v1/webinars?webinar_connection_id=679
```

### Response
#### Success Response (200)
- **webinars** (array) - An array of webinar objects.
  - **id** (string) - Unique identifier for the webinar.
  - **title** (string) - Title of the webinar.

#### Response Example
```json
{
  "webinars": [
    {
      "id": "1964468268",
      "title": "Zoom 1"
    },
    {
      "id": "1964442145",
      "title": "Zoom 2"
    }
  ]
}
```

#### Error Response (400)
- **response_type** (string) - Indicates an error occurred.
- **response_code** (integer) - The HTTP status code for the error.
- **message** (string) - A description of the error.

#### Error Response Example
```json
{
  "response_type": "ERROR",
  "response_code": 400,
  "message": "This endpoint is currently not supported for MS Teams accounts"
}
```
```

--------------------------------

### Create Legacy ILT Session (POST Request)

Source: https://docs.learnupon.com/api/index

This POST endpoint is used to create a new legacy Instructor-led training (ILT) session. It requires various IDs and information gathered from previous calls, such as course details, location, instructor, and webinar connection information.

```http
POST /components/ilt
```

--------------------------------

### GET /course_instructors

Source: https://docs.learnupon.com/api/index

Searches for and lists all course instructors on a portal. This endpoint can also be used with query parameters to filter results.

```APIDOC
## GET /course_instructors

### Description
Searches for and lists all course instructors on a portal. This endpoint can also be used with query parameters to filter results.

### Method
GET

### Endpoint
/api/v1/course_instructors

### Parameters
#### Query Parameters
- **course_id** (integer) - Optional - Course's unique numeric identifier
- **user_id** (integer) - Optional - The unique identifier of the instructor user
- **email** (string) - Optional - The email of the user, used as default unique identifier
- **username** (string) - Optional - Alternate unique identifier for users: available only if you set up usernames in place of email as unique identifier.

### Request Example
```bash
curl -X GET -H "Content-Type: application/json" --user <api_key>:<password> https://yourdomain.learnupon.com/api/v1/course_instructors?course_id=12345
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the course instructor record.
- **user_id** (integer) - The unique identifier for the associated user.
- **course_id** (integer) - The unique identifier for the associated course.
- **created_at** (datetime) - The timestamp when the course instructor record was created.
- **updated_at** (datetime) - The timestamp when the course instructor record was last updated.

#### Response Example
```json
[
  {
    "id": 1,
    "user_id": 101,
    "course_id": 201,
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:00:00Z"
  }
]
```
```

--------------------------------

### Publish Modules

Source: https://docs.learnupon.com/api/index

Publishes audio and video modules. This action makes the modules available for use in courses.

```APIDOC
## POST /modules

### Description
Publish audio and video modules. To add these modules to a course, use the 'Add a module to a course' endpoint.

### Method
POST

### Endpoint
/api/v1/modules

### Parameters
#### Request Body
- **title** (string) - Required - The title of the module.
- **content_type** (string) - Required - The type of content (e.g., 'audio', 'video').
- **attachment_url** (string) - Optional - URL for the audio or video attachment.

### Request Example
```json
{
  "title": "Welcome Video",
  "content_type": "video",
  "attachment_url": "https://example.com/videos/welcome.mp4"
}
```

### Response
#### Success Response (201)
- **id** (integer) - The unique identifier for the newly created module.
- **title** (string) - The title of the module.
- **created_at** (string) - The timestamp when the module was created.
- **updated_at** (string) - The timestamp when the module was last updated.

#### Response Example
```json
{
  "id": 201,
  "title": "Welcome Video",
  "created_at": "2023-01-03T10:00:00Z",
  "updated_at": "2023-01-03T10:00:00Z"
}
```
```

--------------------------------

### Response for Live Learning Event Session Details (JSON)

Source: https://docs.learnupon.com/api/index

This is a sample JSON response detailing a specific Live Learning event session. It includes session information such as ID, title, timings, webinar URL, and instructor details.

```json
{
"session":{
"id":390349,
"portal_id":45678,
"event_id":12345,
"title":"APIs made easy part 3",
"description_html":"<p>Stop worrying and love APIs</p>",
"description_text":"Stop worrying and love APIs",
"num_enrolled":0,
"min_capacity":null,
"max_capacity":null,
"start_time":"2023-11-14T16:00:00",
"end_time":"2023-11-14T17:00:00",
"timezone":"(GMT-05:00) Eastern Time (US & Canada)",
"session_type":"webinar",
"location":"Webinar",
"webinar_url":"https://us02.zoom.us/j/00000000000?pwd=passwordprovidedbyzoom",
"completion_requirement":"attendance required", 
"minimum_attendance_threshold":null,
"instructors":[{
"user_id":654321,
"first_name":"Berengar",
"last_name":"Hesse",
"email":"berengar.hesse@yourdomain.com",
"is_primary":true
},{
"user_id":123456,
"first_name":"Beatrice",
"last_name":"Dansk",
"email":"beatrice.dansk@yourdomain.com",
"is_primary":false
}]
}
}

```

--------------------------------

### List Available Timezones (GET Request)

Source: https://docs.learnupon.com/api/index

This endpoint fetches a list of all supported timezones that can be used when scheduling ILT sessions.

```http
GET /timezones
```

--------------------------------

### GET /api/v1/certifications

Source: https://docs.learnupon.com/api/index

Retrieves a list of certificates available on a LearnUpon portal. This endpoint is useful for discovering available certifications within the system.

```APIDOC
## GET /api/v1/certifications

### Description
Lists certificates available on a portal.

### Method
GET

### Endpoint
/api/v1/certifications

### Parameters
#### Query Parameters
* **None**

#### Request Body
* **None**

### Request Example
```bash
curl -X GET -H "Content-Type: application/json" --user 988d4f1313f881e5ac6bfdfc7f54244aab:905a12r3a0c https://yourdomain.learnupon.com/api/v1/certifications
```

### Response
#### Success Response (200)
- **certifications** (array) - List of certificate names and unique identifiers.
  - **guid** (string) - Unique alphanumeric identifier for each certificate.
  - **title** (string) - Name for the certificate that appears in the interface.

#### Response Example
```json
{
    "certifications": [
        {
            "guid": "2eb0ddf7-2d63-11ef-97d5-06c3fede0100",
            "title": "Driving level 1"
        },
        {
            "guid": "2eb0dff3-2d63-11ef-97d5-06c3fede0100",
            "title": "Driving level 2"
        },
        {
            "guid": "2ea3f61d-2d63-11ef-97d5-06c3fede0100",
            "title": "SNC certificate"
        }
    ]
}
```
```

--------------------------------

### Create an enrollment (enroll users on a course)

Source: https://docs.learnupon.com/api/index

Enrolls a user in a course. Requires either email or username for the user, and either course_name or course_id for the course. Optional parameters include re_enroll_if_completed.

```APIDOC
## POST /api/v1/enrollments

### Description
Enrolls a user in a course. Requires either email or username for the user, and either course_name or course_id for the course.

### Method
POST

### Endpoint
https://yourdomain.learnupon.com/api/v1/enrollments

### Parameters
#### Request Body
- **Enrollment** (object) - Required
  - **email** (string) - Required (if username is not provided) - The email of the user.
  - **username** (string) - Required (if email is not provided) - The username of the user.
  - **course_name** (string) - Required (if course_id is not provided) - The exact title of the course.
  - **course_id** (integer) - Required (if course_name is not provided) - The unique numeric identifier for the course.
  - **re_enroll_if_completed** (boolean) - Optional - Set to `true` to re-enroll the user if they have previously completed the course.

### Request Example
```json
{
  "Enrollment": {
    "email": "learnuponapi@samplelearningco.com",
    "course_name": "Hello API"
  }
}
```

### Response
#### Success Response (200)
- **id** (integer) - Unique numeric identifier for the enrollment.
- **created_at** (date/time) - The date the enrollment was created, in UTC format.

#### Response Example
```json
{
  "id": 12345,
  "created_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Create Video or Audio Module (cURL)

Source: https://docs.learnupon.com/api/index

This snippet demonstrates how to create a new module in LearnUpon that contains either a video or an audio file. It requires a module title and either a video_url or audio_url. Optional parameters include tags. The API endpoint expects a JSON payload.

```shell
curl -X POST -H "Content-Type: application/json" --user 93a306ad8fff2fe3dbd1:d670237770e52266234ecd45678bce -d
'{"module_title":"Api video module", "video_url" : "https://url_to_the_video" }'
https://yourdomain.learnupon.com/api/v1/modules
```

--------------------------------

### GET /api/v1/timezones

Source: https://docs.learnupon.com/api/index

Retrieves a list of timezones available in your LearnUpon portal. The 'id' from this response is required to add a timezone to an ILT module.

```APIDOC
## GET /api/v1/timezones

### Description
This method returns a list of timezones available in your portal. To add a timezone to your ILT module, you need the timezone `id` provided by this call.

### Method
GET

### Endpoint
/api/v1/timezones

### Parameters
#### Query Parameters
This endpoint has no additional parameters.

### Request Example
```bash
curl -X GET -H "Content-Type: application/json" --user <api_key>
https://yourdomain.learnupon.com/api/v1/timezones
```

### Response
#### Success Response (200)
- **timezones** (array) - An array of timezone objects.
  - **id** (string) - Unique identifier for the timezone.
  - **name** (string) - Description which appears in the application.

#### Response Example
```json
{
  "timezones": [
    {
      "id": "Pacific Time (US & Canada)",
      "name": "(GMT-08:00) Pacific Time (US & Canada)"
    },
    {
      "id": "Tijuana",
      "name": "(GMT-08:00) Tijuana"
    }
  ]
}
```
```

--------------------------------

### List Available Locations (GET Request)

Source: https://docs.learnupon.com/api/index

This endpoint retrieves a list of all available locations configured for ILT sessions in your LearnUpon portal.

```http
GET /locations
```
Tokens:
Raw