Acadle API Documentation

Get User Course Progress - The following API can be utilized to retrieve user's course progress from the academy.

Yashika — Fri, 14 Jun 2024 10:14:54 +0000

URL : https://academy.domain.com/api/v2/get-user-course-progressMethod : GETRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body: { "user_id" : 1, // user_id or user_email is required "user_email" : "youremail@email.com" // user_id or user_email is required "page" : 1, // Optional - Default value is 1 "per_page" : 10 // Optional - Default value is 10 - Range: 1...

Get User Course Lesson Progress - The following API can be utilized to retrieve user's lesson progress of the course from the academy.

Yashika — Fri, 14 Jun 2024 10:14:57 +0000

URL : https://academy.domain.com/api/v2/get-user-course-lesson-progressMethod : GETRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body: { "user_id" : 1, // user_id or user_email is required "user_email" : "youremail@email.com" // user_id or user_email is required "course_id" : 1, // Required "page" : 1, // Optional - Default value is 1 "per_page" : 10 // Optional - Default value...

Get User List - The following API can be utilized to retrieve all users from the academy.

Yashika — Fri, 14 Jun 2024 10:14:49 +0000

URL : https://academy.domain.com/api/v2/get-user-listMethod : GETRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body: { "page" : 1, // Optional - Default value is 1 "per_page" : 10 // Optional - Default value is 10 - Range: 1 to 1000 }Response : { "status": "success", "data": [ { "id" : 1, "first_name" : "John", "last_name"...

Invite users - This API can be used to invite users to the academy.

Nizamudheen V — Fri, 17 Jun 2022 10:34:14 +0000

URL : https://academy.domain.com/api/v2/user/invite

Method : POSTRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "data" : [ { "first_name" : "John", // Required "last_name" : "Doe", // Required "email" : "johndoe@email.com", // Required "message" : "This is a custom message", // Optional "group" : [1,4] // Required }, { "first_name" : "Jacob", "last_name" :...

Get User Profile - This API can be used to get the profile of a user

Yashika — Fri, 17 Jun 2022 17:01:36 +0000

URL : https://academy.domain.com/api/v2/user-profileMethod : GETRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "email" : "User's email" // Required }Response : { "status": "success", "data": [ { "id": 11, "first_name": "", "last_name": null, "email": "vishnu@acadle.com", "phone": null, "dial_code": null, "company_name": null, "designation": null, "city": null, "state": null, "country": "United States", "zip": null, "employee_id":...

User Completed Courses List - This API can be used to get all the completed courses of a user.

Yashika — Fri, 17 Jun 2022 12:43:00 +0000

URL : https://academy.domain.com/api/v2/user-courses-completedMethod : GETRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "email" : "User's email", // Required }Response : { "status": "success", "data": [ { "id": 1, "name": "Test Course 1", "description": "Test Course 1", "duration": "00:10 Hours", "completed_at": "2020-10-21 08:00:22", "timezone": "UTC" }, { "id": 2, "name": "Test Course 2",...

Update Groups of User - This API can be used to update / replace access groups of academy user.

Yashika — Fri, 17 Jun 2022 12:27:08 +0000

URL : https://academy.domain.com/api/v2/user-group/updateMethod : POSTRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "email" : "User's email", // Required "groups" : [ group id 1, group id 2, ...], // Required }Response : { "status": "success", "message": "Groups updated successfully", }

Remove Groups from User - This API can be used to remove access groups from the academy user.

Yashika — Fri, 17 Jun 2022 12:24:49 +0000

URL : https://academy.domain.com/api/v2/user-group/removeMethod : POSTRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "email" : "User's email", // Required "groups" : [ group id 1, group id 2, ...], // Required }Response : { "status": "success", "message": "Groups removed successfully", }

Add Groups to User - This API can be used to assign access groups to the academy user.

Yashika — Fri, 17 Jun 2022 12:17:40 +0000

URL : https://academy.domain.com/api/v2/user-group/addMethod : POSTRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "email" : "User's email", // Required "groups" : [ group id 1, group id 2, ...], // Required }Response : { "status": "success", "message": "Groups added successfully", }

Delete Group - This API can be used to remove a group from the academy.

Yashika — Fri, 17 Jun 2022 11:50:42 +0000

URL : https://academy.domain.com/api/v2/group/deleteMethod : DELETERequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "id" : 3 // Required }Response : { "status": "success", "message": "Group deleted successfully" }

List Groups - This API can be used to get all the access groups in the academy.

Yashika — Fri, 17 Jun 2022 11:34:08 +0000

URL : https://academy.domain.com/api/v2/group/listMethod : GETRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Response : { "status": "success", "data": [ { "id": 1, "name": "Default", "status": "active", "default": "yes", "ref_id": null }, { "id": 4, "name": "Test Group 1 Updated", "status": "active", "default": "no", "ref_id": null } ] }

Update Group - This API can be used to update an existing access group in the academy.

Yashika — Fri, 17 Jun 2022 11:22:46 +0000

URL : https://academy.domain.com/api/v2/group/updateMethod : POSTRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "id" : 4 // Required "name" : "Test Group 1 Updated", // Required "active" : true, // Required "default" : false, // Required "ref_id" : null // Optional }Response : { "status": "success", "message": "Group updated successfully", "data": { ...

Create Group - This API can be used to create new access group inside the academy.

Yashika — Fri, 17 Jun 2022 11:16:51 +0000

URL : https://academy.domain.com/api/v2/group/addMethod : POSTRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "name" : "Test Group 1", // Required "active" : true, // Required "default" : false, // Required "ref_id" : null // Optional }Response : { "status": "success", "message": "Group created successfully", "data": { "id": 4, "name": "Test Group 1", "status":...

Update User Status - This API can be used to activate or deactivate a user.

Yashika — Fri, 17 Jun 2022 17:05:42 +0000

URL : https://academy.domain.com/api/v2/user/update/statusMethod : POSTRequest Header : { "Content-Type" : "application/json", "API-Key" : "Your API Key" }Request Body : { "email" : "User's email", // Required "is_active" : true, // Required }Response : { "status": "success", "message": "User status changed successfully" }