Documentation Powered by Redocly

Elevate User (1.0.0)

Download OpenAPI specification:Download

E-mail: info@sunbird.org Terms of Service
  • The Users Service is a centralized Service to support other services. Apis perform operations related to mentoring entities notification etc
  • The URL for Users API(s) is {context}/user/v1 - Note: These resources can be used in other services

User Roles APIs

Get User Roles

Retrieve the list of user roles.

  • Endpoint: /user/v1/userRole/list
  • It is mandatory to provide values for parameters marked as required.
  • The X-auth-token obtained from the login API is required in the header.
query Parameters
page
integer

Please add page number

limit
integer

Number of records to limit

search
string

Please search for information such as 'title' names

user_type
integer

filtering based on the user_type

visibility
string

filtering based on the visibility

status
string

filtering based on the status

organization_id
integer

filtering based on the organization_id

header Parameters
X-auth-token
required
string

X-auth-token obtained from the login API response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Roles fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

Create User Role

Create roles for users.

  • Endpoint: /user/v1/userRole/Create.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the user

Request Body schema: application/json
id
string
title
string
label
string
user_type
number
object
status
string
visibility
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "12",
  • "title": "head_master",
  • "label": "Head Master",
  • "user_type": 1,
  • "meta": {
    },
  • "status": "ACTIVE",
  • "visibility": "PUBLIC",
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Roles added successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update User Roles

Use this API to update an user Role.

  • Endpoint: /user/v1/userRole/update/{id}
  • Provide values for parameters marked as required.
  • The X-auth-token is mandatory and cannot be empty or null.
path Parameters
id
required
integer
Example: 1

Please append a valid user ID to the request URL.

header Parameters
X-auth-token
required
string

Access token obtained from the login API response.

Request Body schema: application/json
title
string
user_type
number
label
string
object
object
status
string
visibility
string

Responses

Request samples

Content type
application/json
{
  • "title": "headmaster_state",
  • "user_type": 1,
  • "label": "Head Master",
  • "meta": {
    },
  • "translations": {
    },
  • "status": "ACTIVE",
  • "visibility": "PUBLIC"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Roles updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Delete User Role

This API is associated with deleting an role.

  • Endpoint for deleting a user role: /user/v1/userRole/delete/{id}.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
path Parameters
id
required
integer
Example: 31

Please append a valid user role ID to the request URL.

header Parameters
X-auth-token
required
string

To use the API, include X-auth-token. This is available in the login API response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Module deleted successfully",
  • "result": { },
  • "meta": {
    }
}

Permissions

Modules

Update Modules

Create modules for users.

  • Endpoint: /user/v1/modules/update.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "allsessionss"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "MODULES_UPDATED_SUCCESSFULLY",
  • "result": {
    },
  • "meta": {
    }
}

Modules List

Get a list of modules.

  • Endpoint: /user/v1/modules/list.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
query Parameters
page
integer

Page number for pagination.

limit
integer

Number of items per page.

search
string

search on code

header Parameters
X-auth-token
required
string

Access token of the admin.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Module fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

RolePermissionMapping

Create Role Permissions Mapping

Create rolePermissionMapping for users.

  • Endpoint: /user/v1/rolePermissionMapping/create.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Request Body schema: application/json
permission_id
number

Responses

Request samples

Content type
application/json
{
  • "permission_id": 1
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Permission added to the role",
  • "result": {
    },
  • "meta": {
    }
}

Delete rolePermissionMapping

Create rolePermissionMapping for users.

  • Endpoint: /user/v1/rolePermissionMapping/delete.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Request Body schema: application/json
permission_id
required
number

Responses

Request samples

Content type
application/json
{
  • "permission_id": 1
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "ROLE_PERMISSION_MAPPING_DELETED_SUCCESSFULLY",
  • "result": { },
  • "meta": {
    }
}

Health Check

Service health status.

This API is used to verify the health status of the user Service and its dependencies.

  • The API Endpoint for health check is /user/health
  • It is mandatory to provide values for parameters that are marked as required
  • This is a mandatory parameter and cannot be empty or null

Responses

Response samples

Content type
application/json
{
  • "id": "service.health.api",
  • "ver": "1.0",
  • "ts": "2025-07-18T06:26:10.726Z",
  • "params": {
    },
  • "status": 200,
  • "result": {
    }
}

User APIs

Create user

This Api is associated with Create User on mentoring

  • Then Endpoint for creating user /user/v1/account/create
  • It is mandatory to provide values for parameter marked with required
  • Mandatory parameter cannot be empty or null
Request Body schema: application/json

Request body consist of metadata and accepts payload as JSON

name
required
string

Name of the user

email
required
string

Email Id of user

password
required
string <password>

Password of user

otp
string

Email OTP for verification

has_accepted_terms_and_conditions
boolean

Flag specifiying if user has accepted the terms & conditions

Responses

Request samples

Content type
application/json
{
  • "name": "John Deo",
  • "email": "example@mail.com",
  • "password": "Password",
  • "otp": 6845975,
  • "has_accepted_terms_and_conditions": true
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Sign-up successful Please wait while logging in.",
  • "result": {
    }
}

Login

This API is associated with logging in a user.

  • Endpoint for logging in a user: /user/v1/account/login
  • It is mandatory to provide values for parameters marked as required.
  • Mandatory parameters cannot be empty or null.
Request Body schema: application/json

Request body for user login

email
required
string

Email address of the user

password
required
string

User password

Responses

Request samples

Content type
application/json
{
  • "email": "example@mail.com",
  • "password": "Password"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User logged in successfully.",
  • "result": {
    }
}

Generate Access Token

This API is for re-login and generating an access token from a refresh token.

  • Endpoint for generating token /user/v1/account/generateToken
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To use the API, you require X-auth-token, available in the login API response.

Request Body schema: application/json
refresh_token
required
string

Refresh token.

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7Il9pZCI6IjYyODMyNTMxYTA1Y2JkNTdiMjczYWViYiIsImVtYWlsIjoiYW5raXQuc0BwYWNld2lzZG9tLmNvbSIsIm5hbWUiOiJBbmtpdCIsImlzQU1lbnRvciI6dHJ1ZX0sImlhdCI6MTY1MzAxMDYxNCwiZXhwIjoxNjY4ODIxODE0fQ.hrIiKz3envHDPauVXSmA_BO_KKzWJAePsP3xD8l851s"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Access token generated successfully",
  • "result": {
    }
}

Generate OTP

This API is for generating OTP.

  • Endpoint: /user/v1/account/generateOtp
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
email
required
string

Email address of the user

password
required
string

User password

Responses

Request samples

Content type
application/json
{
  • "email": "example@mail.com",
  • "password": "Password"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "OTP has been sent to your registered email ID. Please enter the number to update your password.",
  • "result": [ ]
}

Reset Password

This API is for resetting the user password.

  • Endpoint: /user/v1/account/resetPassword
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
email
required
string

Email address of the user

password
required
string

New password of the user

otp
required
number

OTP sent to the user's email

Responses

Request samples

Content type
application/json
{
  • "email": "example@mail.com",
  • "password": "New password",
  • "otp": 123456
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Password reset successfully.",
  • "result": {
    }
}

Logout

This API is for logging out a user.

  • Endpoint: /user/v1/account/logout
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
refresh_token
string

Refresh token.

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7Il9pZCI6IjYyODMyNTMxYTA1Y2JkNTdiMjczYWViYiIsImVtYWlsIjoiYW5raXQuc0BwYWNld2lzZG9tLmNvbSIsIm5hbWUiOiJBbmtpdCIsImlzQU1lbnRvciI6dHJ1ZX0sImlhdCI6MTY1MzAxMDYxNCwiZXhwIjoxNjY4ODIxODE0fQ.hrIiKz3envHDPauVXSmA_BO_KKzWJAePsP3xD8l851s"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User logged out successfully.",
  • "result": [ ]
}

Registration OTP

This API is for registration OTP.

  • Endpoint: /user/v1/account/registrationOtp
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
name
string
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "name": "Anu",
  • "email": "anu@gmail.com",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "OTP has been sent to your registered email ID. Please enter the otp to complete the registration process.",
  • "result": [ ]
}

Depreciated APIs

Terms & Condition

This API sets the 'email_verified' field to true using only the X-auth-token.

  • Endpoint: /user/v1/account/acceptTermsAndCondition
  • Requires a valid X-auth-token from the login API response.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User successfully updated.",
  • "result": [ ]
}

Users APIs

List user

This API lists users based on specified conditions.

  • Endpoint: /user/v1/account/list
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
query Parameters
userType
required
string
Example: userType=mentor

Type of user

page
number
Example: page=1

Page number for pagination.

limit
number
Example: limit=2

Number of records to limit.

search
string
Example: search=john

Search for name or title of user, etc.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application/json
{}

Search User

This API searches users based on specified conditions.

  • Endpoint: /user/v1/account/search
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
query Parameters
type
required
string
Example: type=mentor

Valid user types like mentee, mentor, session_manager, org_admin, reviewer. Use the keyword all to search users without passing specific roles.

page
number
Example: page=1

Page number for pagination.

limit
number
Example: limit=2

Number of records to limit.

search
string
Example: search=john

Search for the name or title of the user, etc.

header Parameters
X-auth-token
required
string

To use the API, you require an X-auth-token, available in the login API response.

Request Body schema: application/json
user_ids
Array of strings

A list of user IDs to include in the search.

email_ids
Array of strings

A list of email IDs to include in the search.

excluded_user_ids
Array of strings

A list of user IDs to exclude from the search.

Responses

Request samples

Content type
application/json
Example

This example searches for specific users by their IDs and email IDs, while excluding certain users.

{
  • "user_ids": [
    ],
  • "email_ids": [
    ],
  • "excluded_user_ids": [
    ]
}

Response samples

Content type
application/json
{}

User Details

This API retrieves details of a user's profile.

  • Endpoint: /user/v1/user/read/{userId}
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
path Parameters
userId
required
integer
Example: 1

Please append a valid User ID to the Request URL.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Profile fetched successfully.",
  • "result": {
    }
}

Setting preferred language of user

This API updates a user's preferred language.

  • Endpoint: /user/v1/user/setLanguagePreference
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
name
string

The user's name.

location
Array of strings
about
string

A brief description about the user.

has_accepted_terms_and_conditions
boolean

Indicates whether the user has accepted terms and conditions.

gender
string

The user's gender.

image
string

URL of the user's profile image.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Profile updated successfully.",
  • "result": {
    }
}

Update User Profile

This API updates a user's profile.

  • Endpoint: /user/v1/user/update
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
name
string

The user's name.

location
Array of strings
about
string

A brief description about the user.

has_accepted_terms_and_conditions
boolean

Indicates whether the user has accepted terms and conditions.

gender
string

The user's gender.

image
string

URL of the user's profile image.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Profile updated successfully.",
  • "result": {
    }
}

Share Mentor Profile

This API is associated with sharing a mentor's profile.

  • Endpoint for sharing a mentor's profile: /user/v1/user/share/{userId}
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
path Parameters
userId
required
string
Example: 1

Please append a valid User ID to the Request URL.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Profile share link generated successfully.",
  • "result": {
    }
}

Cloud Services APIs

Cloud Services - Get Signed URL

This API is associated with cloud services for obtaining a signed URL.

  • Endpoint for cloud services: /user/v1/cloud-services/file/getSignedUrl
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
path Parameters
file_name
required
string
Example: image.jpg

Please append a valid file name to the URL, indicating the file to be uploaded.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application/json
{}

Cloud Services - Get Downloadable URL

This API is associated with cloud services for obtaining a downloadable URL.

  • Endpoint for cloud services: /user/v1/cloud-services/file/getDownloadableUrl
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
path Parameters
file_path
required
string
Example: users/62832531a05cbd57b273aebb-1654149589875-image.jpg

Please append a valid file path to the URL, indicating the file to be downloaded.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application/json
{}

Cloud Services - Get Sample CSV

This API is associated with cloud services for obtaining a sample CSV file for bulk user create.

  • Endpoint for cloud services: /user/v1/cloud-services/file/getSampleCSV
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Responses

Response samples

Content type
application/json
{}

Form APIs

Create Form

This API is associated with creating a form.

  • Endpoint for creating a form: /user/v1/form/create
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
type
required
string

The type of the form.

sub_type
required
string

The sub-type or category of the form.

required
object

The main data structure for the form.

Responses

Request samples

Content type
application/json
{
  • "type": "profile",
  • "sub_type": "profileForm",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Form created successfully",
  • "result": [ ]
}

Update Form

This API is associated with updating a form.

  • Endpoint for updating a form: /user/v1/form/update/{formId}
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
path Parameters
formId
required
string
Example: 1

Please append a valid form ID to the request URL.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
type
required
string

The type of the form.

sub_type
required
string

The sub-type or category of the form.

required
object

The main data structure for the form.

Responses

Request samples

Content type
application/json
{
  • "type": "profile",
  • "sub_type": "profileForm",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Form updated successfully",
  • "result": [ ]
}

Get Form Details

This API is associated with retrieving form details.

  • Endpoint for retrieving form details: /user/v1/form/read/{formId}
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
path Parameters
formId
required
integer
Example: 2

Please append a valid form Id to the Request URL.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
type
string

Type of form.

sub_type
string

Subtype of the form.

Responses

Request samples

Content type
application/json
{
  • "type": "profile",
  • "sub_type": "profileForm"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Form fetched successfully",
  • "result": {
    }
}

Admin APIs

Create Admin User

API associated with creating a new admin user.

  • Endpoint for creating a system user: /user/v1/admin/create
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
Request Body schema: application/json
name
required
string

Name of the system user.

email
required
string

Email of the system user.

password
required
string <password>

Password for the system user.

secret_code
required
string

Secret code for system user creation.

Responses

Request samples

Content type
application/json
{
  • "name": "John Deo",
  • "email": "systemuser@mail.com",
  • "password": "password",
  • "secret_code": "secret_code"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Sign-up successful, Please wait while logging in.",
  • "result": [ ]
}

Admin Login

This API is associated with the login of the system user.

  • Endpoint for login system user: /user/v1/admin/login
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
Request Body schema: application/json
email
required
string

Email of the system user.

password
required
string <password>

Password of the system user.

Responses

Request samples

Content type
application/json
{
  • "email": "systemuser@mail.com",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User logged in successfully.",
  • "result": {
    }
}

Delete User

Delete a user.

  • Endpoint: /user/v1/admin/deleteUser
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
path Parameters
id
required
string
Example: 1

User ID to be deleted. Please append a valid user ID to the request URL.

header Parameters
X-auth-token
required
string

X-auth-token required for API access. Available in login API Response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User deleted successfully",
  • "result": [
    ]
}

Add Organization Admin

Assigns a user as the Org-Admin.

  • Endpoint: /user/v1/admin/addOrgAdmin
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

X-auth-token required for API access. Available in login API Response.

Request Body schema: application/json
user_id
integer

The ID of the user to be assigned as Org-Admin.

organization_id
integer

The ID of the organization to which the user will be assigned as Org-Admin.

Responses

Request samples

Content type
application/json
{
  • "user_id": 12,
  • "organization_id": 55
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User Assigned As The Org-Admin Successfully",
  • "result": {
    }
}

Deactivate Organization

Deactivates an organization.

  • Endpoint: /user/v1/admin/deactivateOrg
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
path Parameters
id
required
string
Example: 1

Please append a valid organization ID to the request URL.

header Parameters
X-auth-token
required
string

X-auth-token required for API access. Available in login API Response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Organization deactivated Successfully.",
  • "result": [
    ]
}

Deactivate User

Deactivates one or more users.

  • Endpoint: /user/v1/admin/deactivateUser
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

X-auth-token required for API access. Available in login API Response.

Request Body schema: application/json
id
Array of integers

Responses

Request samples

Content type
application/json
{
  • "id": [
    ]
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User deactivated Successfully.",
  • "result": [ ]
}

Organization

Create Organization

Creates a new organization.

  • Endpoint: /user/v1/organization/create
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

X-auth-token required for API access. Available in the login API Response.

Request Body schema: application/json
name
required
string

The name of the organization.

code
required
string

A unique code representing the organization.

description
required
string

A brief description of the organization.

Responses

Request samples

Content type
application/json
{
  • "name": "MentorEd",
  • "code": "mentor112",
  • "description": "testing"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Organization created successfully",
  • "result": [ ]
}

Update Organization

This API is associated with updating an organization.

  • Endpoint for updating organization: /user/v1/organization/update
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
path Parameters
id
required
integer
Example: 1

Please append a valid organization ID to the request URL.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is available in the login API response.

Request Body schema: application/json
name
required
string

The name of the organization.

code
required
string

A unique code representing the organization.

description
required
string

A brief description of the organization.

Responses

Request samples

Content type
application/json
{
  • "name": "MentorEd",
  • "code": "mentor112",
  • "description": "testing"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Organization updated successfully",
  • "result": [ ]
}

List Organization

This API is associated with listing organizations based on specified conditions.

  • Endpoint for listing organizations: /user/v1/organization/list
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
query Parameters
page
number
Example: page=1

Please specify the page number.

limit
number
Example: limit=2

Specify the number of records to limit.

search
string
Example: search=john

Search for organizations based on name or title.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is available in the login API response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Organization fetched successfully.",
  • "result": {
    }
}

Request Org Role

This API is associated with requesting a specific role within an organization.

  • Endpoint: /user/v1/organization/requestOrgRole
  • Mandatory parameters marked as required must have valid values.
  • Parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

User's access token, which already recognizes the user as the organization's mentee.

Request Body schema: application/json

Request body containing role information.

role
integer

The specific role being requested.

object

Additional data related to the organization-specific fields.

Responses

Request samples

Content type
application/json
{
  • "role": 2,
  • "form_data": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Mentor role requested successfully",
  • "result": {
    }
}

EntityType APIs

Create Entity Type

Use this API to create a user entity.

  • Endpoint: /mentoring/v1/entity-type/create
  • Provide values for parameters marked as required.
  • The X-auth-token is mandatory and cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the user who is already a mentee of the organization.

Request Body schema: application/json
value
string

Unique identifier for the entity type.

label
string

Descriptive label for the entity type.

type
string

Type of the entity (e.g., SYSTEM, USER).

allow_filtering
boolean

Indicates whether filtering is allowed for this entity type.

data_type
string

Data type of the entity.

has_entities
boolean

Indicates whether the entity type has associated entities.

Responses

Request samples

Content type
application/json
{
  • "value": "ln",
  • "label": "Languages",
  • "type": "SYSTEM",
  • "allow_filtering": true,
  • "data_type": "string",
  • "has_entities": "STRING"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Entity type created successfully.",
  • "result": {
    }
}

Read Entity Type

Use this API to retrieve a list of entity types.

  • Endpoint: /user/v1/entity-type/read
  • Provide values for parameters marked as required.
  • The X-auth-token is mandatory and cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
value
Array of strings
read_user_entity
boolean

Responses

Request samples

Content type
application/json
{
  • "value": [
    ],
  • "read_user_entity": false
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity type fetched successfully",
  • "result": [
    ],
  • "meta": {
    }
}

Delete Entity Type

This API is associated with deleting an entity type. - Endpoint for deleting a user entity: /user/v1/entity-type/delete - It is mandatory to provide values for parameters marked with required. - Mandatory parameters cannot be empty or null.

path Parameters
id
required
integer
Example: 31

Please append a valid user entity ID to the request URL.

header Parameters
X-auth-token
required
string

To use the API, include X-auth-token. This is available in the login API response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Entity deleted successfully",
  • "result": [ ]
}

Update Entity Type

Use this API to update an entity type.

  • Endpoint: /user/v1/entity-type/update/{id}
  • Provide values for parameters marked as required.
  • The X-auth-token is mandatory and cannot be empty or null.
path Parameters
id
required
integer
Example: 1

Please append a valid user ID to the request URL.

header Parameters
X-auth-token
required
string

Access token obtained from the login API response.

Request Body schema: application/json
value
string

Unique identifier for the entity type.

label
string

Descriptive label for the entity type.

type
string

Type of the entity (e.g., SYSTEM, USER).

allow_filtering
boolean

Indicates whether filtering is allowed for this entity type.

data_type
string

Data type of the entity.

has_entities
boolean

Indicates whether the entity type has associated entities.

Responses

Request samples

Content type
application/json
{
  • "value": "ln",
  • "label": "Languages",
  • "type": "SYSTEM",
  • "allow_filtering": true,
  • "data_type": "string",
  • "has_entities": "STRING"
}

Response samples

Content type
application/json
{
  • "responseCode": "string",
  • "message": "string",
  • "result": {
    },
  • "meta": {
    }
}

Delete Entity

This API is associated with deleting an entity.

  • Endpoint for deleting a user entity: /user/v1/entity/delete.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
path Parameters
id
required
integer
Example: 31

Please append a valid user entity ID to the request URL.

header Parameters
X-auth-token
required
string

To use the API, include X-auth-token. This is available in the login API response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Entity deleted successfully",
  • "result": [ ]
}

Bulk User Create

Create multiple users in bulk using a CSV file.

  • Endpoint: /user/v1/org-admin/bulkUserCreate.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the org admin.

Request Body schema: application/json
file_path
string

The path to the uploaded CSV file containing user data.

Responses

Request samples

Content type
application/json
{
  • "file_path": "path/to/uploaded-csv-file"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Bulk User Invites CSV Uploaded Successfully",
  • "result": {
    }
}

Get Bulk Invite Files List

Get a list of uploaded bulk invite CSV files.

  • Endpoint: /user/v1/org-admin/getBulkInvitesFilesList.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of items per page.

status
required
string
Enum: "uploaded" "processed" "failed"
Example: status=uploaded

Status of the bulk invite files (uploaded/processed/failed).

header Parameters
X-auth-token
required
string

Access token of the org admin.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Bulk Invites CSV List Fetched Successfully",
  • "result": {
    }
}

Create Permissions

Create permissions for users.

  • Endpoint: /user/v1/permissions/create.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Request Body schema: application/json
code
required
string

unique permission name

module
required
string

module name

request_type
required
Array of strings

request types of the api

api_path
required
string

permission api path

status
string

status of the permission

Responses

Request samples

Content type
application/json
{
  • "code": "ssss",
  • "module": "ssss",
  • "request_type": [
    ],
  • "api_path": "/mentoring/v1/sessions/sections/",
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "PERMISSION_CREATED_SUCCESSFULLY",
  • "result": {
    },
  • "meta": {
    }
}

Update Permissions

Create permissions for users.

  • Endpoint: /user/v1/permissions/update.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Request Body schema: application/json
code
required
string

unique permission name

module
required
string

module name

request_type
required
Array of strings

request types of the api

api_path
required
string

permission api path

status
string

status of the permission

Responses

Request samples

Content type
application/json
{
  • "code": "ssss",
  • "module": "ssss",
  • "request_type": [
    ],
  • "api_path": "/mentoring/v1/sessions/sections/",
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "PERMISSION_UPDATED_SUCCESSFULLY",
  • "result": {
    },
  • "meta": {
    }
}

Permissions List

Get a list of permissions.

  • Endpoint: /user/v1/permissions/list.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
query Parameters
page
integer

Page number for pagination.

limit
integer

Number of items per page.

search
string

search on code

header Parameters
X-auth-token
required
string

Access token of the admin.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Permissions fetched successfully",
  • "result": {
    },
  • "meta": {
    }
}

Delete Permissions

Create permissions for users.

  • Endpoint: /user/v1/permissions/delete.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Permission deleted successfully",
  • "result": { },
  • "meta": {
    }
}

Create Modules

Create modules for users.

  • Endpoint: /user/v1/modules/create.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "systemadmin"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "MODULES_CREATED_SUCCESSFULLY",
  • "result": {
    },
  • "meta": {
    }
}

Delete Modules

Create modules for users.

  • Endpoint: /user/v1/modules/delete.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the admin.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Module deleted successfully",
  • "result": { },
  • "meta": {
    }
}

Entity APIs

Create Entity

This API is associated with entity creation.

  • Endpoint for creating an entity: /user/v1/entity/create.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application/json
value
required
string
label
required
string
type
required
string
entity_type_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "value": "AP",
  • "label": "Andhra Pradesh",
  • "type": "string",
  • "entity_type_id": 4
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity created successfully",
  • "result": {
    },
  • "meta": {
    }
}

Update Entity

This API is associated with updating an entity.

  • Endpoint for updating an entity: /user/v1/entity/update.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
path Parameters
id
required
integer
Example: 2

Please append a valid user entity ID to the request URL.

header Parameters
X-auth-token
required
string

To make use of the API, you require X-auth-token. This is Available in login API Response.

Request Body schema: application.json
value
string

The value of the entity.

label
string

The label of the entity.

status
string

The status of the entity.

entity_type_id
number

The ID of the entity type.

Responses

Request samples

Content type
application.json
{
  • "value": "en",
  • "label": "English",
  • "status": "ACTIVE",
  • "entity_type_id": 1
}

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity updated successfully",
  • "result": {
    },
  • "meta": {
    }
}

Read User Entity

This API is associated with retrieving a user entity based on ID or value.

  • Endpoint for retrieving a user entity: /user/v1/entity/read.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
query Parameters
id
required
integer
Example: id=1

Please append a valid ID.

header Parameters
X-auth-token
required
string

To use the API, include X-auth-token. This is available in the login API response.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Entity fetched successfully",
  • "result": [
    ]
}

Get entity list with pagination and search

Use this API to get the list of a user entities.

  • The API Endpoint for reading the list of the user entities is /user/v1/entity/list
  • It is mandatory to provide values for parameters which are marked as required
  • This is a mandatory parameter and cannot be empty or null.
path Parameters
page
number
Example: 1

Please add page number

limit
number
Example: 10

Number of records to limit

search
string
Example: teacher

search text

entity_type_id
required
number
Example: teacher

entity_type_id

header Parameters
X-auth-token
required
string

To use this API, you require an X-auth-token, which is available in the login API Response.

Responses

Response samples

Content type
application.json
{
  • "responseCode": "OK",
  • "message": "Entity fetched successfully",
  • "result": {
    },
  • "meta": {
    },
  • "parameters": [ ]
}

Org Admin APIs

Get Requests

Get a list of organization requests based on specified filters

  • Endpoint: /user/v1/org-admin/getRequests.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
query Parameters
page
required
integer

Page number for pagination.

limit
required
integer

Number of items per page.

header Parameters
X-auth-token
required
string

Access token of the org admin.

Request Body schema: application/json

Request body for filtering organization requests.

  • role: An array of role IDs.
  • status: An array of request statuses.
  • handled_by: An array of user IDs who handled the requests.
object

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Organization requests fetched successfully",
  • "result": {
    }
}

Update Request Status

Update the status of an organization request.

  • Endpoint: /user/v1/org-admin/updateRequestStatus.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the org admin.

Request Body schema: application/json
request_id
integer

The ID of the organization request to be updated.

comments
Array of strings

Comments related to the request status update.

status
string
Enum: "APPROVED" "REJECTED" "UNDER_REVIEW"

The new status for the organization request.

Responses

Request samples

Content type
application/json
{
  • "request_id": 12,
  • "comments": [
    ],
  • "status": "APPROVED"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Successfully updated organization request status",
  • "result": {
    }
}

Get Request Details

Get details of a specific organization request.

  • Endpoint: /user/v1/org-admin/getRequestDetails.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
query Parameters
request_id
required
integer
Example: request_id=12

ID of the request to get details for.

header Parameters
X-auth-token
required
string

Access token of the org admin.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Organisation request details fetched successfully",
  • "result": {
    }
}

Deactivate User

Deactivate a user

  • Endpoint: /user/v1/org-admin/deactivateUser.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
path Parameters
id
required
integer
Example: 12

ID of the user.

header Parameters
X-auth-token
required
string

Access token of the org admin.

Responses

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "User deactivated Successfully.",
  • "result": [ ]
}

Inherit Entity Type

Inherit entity type.

  • Endpoint: /user/v1/org-admin/inheritEntityType.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token of the org admin.

Request Body schema: application/json
entity_type_value
string
target_entity_type_label
string

Responses

Request samples

Content type
application/json
{
  • "entity_type_value": "categories",
  • "target_entity_type_label": "training"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Entity type created successfully",
  • "result": {
    }
}

Notification APIs

Create, Update, and Delete Notification

This API is associated with notification create or update.

  • Endpoint: /user/v1/notification/template.
  • It is mandatory to provide values for parameters marked with required.
  • Mandatory parameters cannot be empty or null.
header Parameters
X-auth-token
required
string

Access token required to use the API. Available in the login API response.

Request Body schema: application/json
type
string

Type of email

code
string

Unique code for the email configuration

subject
string

Subject of the email

body
string

Body of the email

email_header
string

Email header content

email_footer
string

Email footer content

Responses

Request samples

Content type
application/json
{
  • "type": "email",
  • "code": "tl-email-invite",
  • "subject": "Hi Welcome Back",
  • "body": "<p>Dear User,</p> Welcome back to mentorEd",
  • "email_header": "email_header",
  • "email_footer": "email_footer"
}

Response samples

Content type
application/json
{
  • "responseCode": "OK",
  • "message": "Notification template created successfully",
  • "result": {
    }
}