Download OpenAPI specification:
Documentation of uExcelerate server app, where you can find all rest-api.
Submits mark admin onboarding stage complete.
From routes/admin/control_panel.js — calls adminControlPanelController.markOnboardingStageComplete
Backed by controller adminControlPanelController.markOnboardingStageComplete.
| stageNum | number Stage num field |
{- "stageNum": 1
}{- "result": "SUCCESS"
}Retrieves admin onboarding info.
From routes/admin/control_panel.js — calls adminControlPanelController.adminOnboardingInfo
Backed by controller adminControlPanelController.adminOnboardingInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves admin personal info.
From routes/admin/control_panel.js — calls adminControlPanelController.getAdminPersonalInfo
Backed by controller adminControlPanelController.getAdminPersonalInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates admin personal info.
From routes/admin/control_panel.js — calls adminControlPanelController.updateAdminPersonalInfo
Backed by controller adminControlPanelController.updateAdminPersonalInfo.
| key | string Key field |
| value | any Value field |
{- "key": "sample key",
- "value": null
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits change admin password.
From routes/admin/control_panel.js — calls adminControlPanelController.changePassword
Backed by controller adminControlPanelController.changePassword.
| password | string User password (plaintext at API boundary; hashed server-side) |
{- "password": "Pa$$w0rd123"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves admin corporate info.
From routes/admin/control_panel.js — calls adminControlPanelController.getAdminCorporateInfo
Backed by controller adminControlPanelController.getAdminCorporateInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves corporate enabled services.
From routes/admin/control_panel.js — calls adminControlPanelController.getCorporateEnabledServices
Backed by controller adminControlPanelController.getCorporateEnabledServices.
| corporateId | number Corporate (account) ID |
{- "corporateId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves active programs.
From routes/admin/control_panel.js — calls adminControlPanelController.getActivePrograms
Backed by controller adminControlPanelController.getActivePrograms.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates admin corporate info.
From routes/admin/control_panel.js — calls adminControlPanelController.updateAdminCorporateInfo
Backed by controller adminControlPanelController.updateAdminCorporateInfo.
| key | string Key field |
| value | any Value field |
{- "key": "sample key",
- "value": null
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits switch corporate plan.
From routes/admin/control_panel.js — calls adminControlPanelController.switchPlan
Backed by controller adminControlPanelController.switchPlan.
| planName | string Plan name field |
{- "planName": "sample plan name"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates integration request.
From routes/admin/control_panel.js — calls adminControlPanelController.integrationRequest
Backed by controller adminControlPanelController.integrationRequest.
| integrationType | string Integration type field |
| integrationStatus | string Integration status field |
{- "integrationType": "sample integration type",
- "integrationStatus": "sample integration status"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates custom integration request.
From routes/admin/control_panel.js — calls adminControlPanelController.customIntegrationRequest
Backed by controller adminControlPanelController.customIntegrationRequest.
| integrationType | string Integration type field |
| reason | string Reason field |
{- "integrationType": "sample integration type",
- "reason": "sample reason"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Removes integration request.
From routes/admin/control_panel.js — calls adminControlPanelController.removeIntegrationRequest
Backed by controller adminControlPanelController.removeIntegrationRequest.
| integrationType | string Integration type field |
| reason | string Reason field |
{- "integrationType": "sample integration type",
- "reason": "sample reason"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves integration config info.
From routes/admin/control_panel.js — calls adminControlPanelController.getIntegrationConfigInfo
Backed by controller adminControlPanelController.getIntegrationConfigInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits request an add-on.
From routes/admin/control_panel.js — calls adminControlPanelController.addOnRequest
Backed by controller adminControlPanelController.addOnRequest.
| addOnRequested | string Add on requested field |
{- "addOnRequested": "sample add on requested"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Removes an add-on request.
From routes/admin/control_panel.js — calls adminControlPanelController.removeAddOnRequest
Backed by controller adminControlPanelController.removeAddOnRequest.
| addOnRequested | string Add on requested field |
{- "addOnRequested": "sample add on requested"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves add-ons info.
From routes/admin/control_panel.js — calls adminControlPanelController.getAddOnsInfo
Backed by controller adminControlPanelController.getAddOnsInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves recent activities.
From routes/admin/control_panel.js — calls adminControlPanelController.getRecentActivities
Backed by controller adminControlPanelController.getRecentActivities.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves balance info.
From routes/admin/control_panel.js — calls adminControlPanelController.getBalanceInfo
Backed by controller adminControlPanelController.getBalanceInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves actions for an engagement.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.getActionsForEngagement
Backed by controller engagementActionsController.getActionsForEngagement.
| programId required | string |
| engagementId required | string |
| status | string Enum: "In Progress" "Completed" "Overdue" |
{- "success": true,
- "data": [ ]
}Creates action for an engagement (multipart/form-data with files[]).
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.createAction
Backed by controller engagementActionsController.createAction.
| programId required | string |
| engagementId required | string |
| title | string Display title |
| instructions | string Instructions field |
| dueDate | string <date> Target completion date (ISO 8601) |
| learnerIds | Array of numbers Learner ids field |
Array of objects Links field | |
Array of objects Tasks field | |
| folder | string Folder field |
| files[] | Array of strings <binary> [ items <binary > ] Files[] field |
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves action details.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.getActionDetails
Backed by controller engagementActionsController.getActionDetails.
| actionId required | string |
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates an action.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.updateAction. learnerIds reassignment is intentionally blocked (409).
Backed by controller engagementActionsController.updateAction..
| actionId required | string |
| title | string Display title |
| instructions | string Instructions field |
| dueDate | string <date> Target completion date (ISO 8601) |
| learnerIds | Array of numbers Learner ids field |
| progress | number Progress percentage (0-100) |
{- "title": "Sample title",
- "instructions": "sample instructions",
- "dueDate": "2026-12-31",
- "learnerIds": [ ],
- "progress": 50
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Removes an action.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.deleteAction
Backed by controller engagementActionsController.deleteAction.
| actionId required | string |
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves learner-specific action details.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.getLearnerDetails
Backed by controller engagementActionsController.getLearnerDetails.
| actionId required | string |
| learnerId required | string |
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates learner action status.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.updateLearnerActionStatus
Backed by controller engagementActionsController.updateLearnerActionStatus.
| actionId required | string |
| learnerId required | string |
{ }{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates resource to action (file/link/task — multipart for file).
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.addResourceToAction. Discriminated by type (file|link|task).
Backed by controller engagementActionsController.addResourceToAction..
| actionId required | string |
| type | string Enum: "file" "link" "task" Type field |
| folder | string Folder field |
| name | string Display name |
| url | string <uri> Resource URL |
| title | string Display title |
| description | string Description field |
| text | string Text field |
| file | string <binary> File field |
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Removes resource from action.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.removeResourceFromAction
Backed by controller engagementActionsController.removeResourceFromAction.
| actionId required | string |
| resourceId required | string |
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Sends chat message on a learner action.
From routes/admin/connections/programs/engagements/engagementActions.js — calls engagementActionsController.sendChatMessage
Backed by controller engagementActionsController.sendChatMessage.
| actionId required | string |
| learnerId required | string |
| message | string Human-readable status message |
{- "message": "Operation completed"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves active programs data.
From routes/admin/home.js — calls adminHomeController.getActiveProgramsData
Backed by controller adminHomeController.getActiveProgramsData.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves pending activities.
From routes/admin/home.js — calls coachHomeController.getPendingActivities
Backed by controller coachHomeController.getPendingActivities.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves insights filter options.
From routes/admin/insights.js — calls adminInsightsController.getFilterData
Backed by controller adminInsightsController.getFilterData.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user programs.
From routes/admin/insights.js — calls adminInsightsController.getUserPrograms
Backed by controller adminInsightsController.getUserPrograms.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user corporate info list.
From routes/admin/insights.js — calls adminInsightsController.getUserCoprorateInfo
Backed by controller adminInsightsController.getUserCoprorateInfo.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves connected users.
From routes/admin/insights.js — calls adminInsightsController.getConnectedUsers
Backed by controller adminInsightsController.getConnectedUsers.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves admin insight statistics.
From routes/admin/insights.js — calls adminInsightsController.getAdminInsightStatistics
Backed by controller adminInsightsController.getAdminInsightStatistics.
| learnerId | number Learner's user ID |
| coachId | number Coach's user ID |
| programId | number Program ID |
| corporateId | number Corporate (account) ID |
| startDate | string <date> Start date (ISO 8601) |
| endDate | string <date> End date (ISO 8601) |
| sessionType | string Session type field |
{- "learnerId": 12345,
- "coachId": 12345,
- "programId": 12345,
- "corporateId": 12345,
- "startDate": "2026-05-13",
- "endDate": "2026-05-13",
- "sessionType": "sample session type"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves one-on-one leaderboard data.
From routes/admin/insights.js — calls adminInsightsController.getOneOnOneLeaderBoardData
Backed by controller adminInsightsController.getOneOnOneLeaderBoardData.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves group leaderboard data.
From routes/admin/insights.js — calls adminInsightsController.getGroupLeaderBoardData
Backed by controller adminInsightsController.getGroupLeaderBoardData.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits export all tool response summary as CSV.
From routes/admin/insights.js — calls adminInsightsController.getAllToolResponseSummaryCsv
Backed by controller adminInsightsController.getAllToolResponseSummaryCsv.
| programId | number Program ID |
| toolId | number Coaching tool ID |
| statusFilter | string Status filter field |
| corporateId | number Corporate (account) ID |
| learnerId | number Learner's user ID |
| coachId | number Coach's user ID |
| startDate | string <date> Start date (ISO 8601) |
| endDate | string <date> End date (ISO 8601) |
{- "programId": 12345,
- "toolId": 12345,
- "statusFilter": "sample status filter",
- "corporateId": 12345,
- "learnerId": 12345,
- "coachId": 12345,
- "startDate": "2026-05-13",
- "endDate": "2026-05-13"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves programs.
From routes/admin/programs.js — calls adminProgramsController.getProgramDetailsList
Backed by controller adminProgramsController.getProgramDetailsList.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates program.
From routes/admin/programs.js — calls adminProgramsController.createProgram
Backed by controller adminProgramsController.createProgram.
| programId | number Program ID |
| corporateId | number Corporate (account) ID |
| name | string Display name |
| description | string Description field |
| level | Array of numbers Level field |
| startDate | string <date> Start date (ISO 8601) |
| endDate | string <date> End date (ISO 8601) |
| managerId | number Manager id (identifier) |
| managers | Array of objects Managers field |
| enableCoachSearch | boolean Enable coach search field |
| enableAICoach | boolean Enable aicoach field |
| enableNudges | boolean Enable nudges field |
| enableReminders | boolean Enable reminders field |
| enableRerports | boolean Enable rerports field |
| enableInternalCoachPool | boolean Enable internal coach pool field |
| enableMarketplaceCoachPool | boolean Enable marketplace coach pool field |
| programCode | string Program code field |
{- "programId": 12345,
- "corporateId": 12345,
- "name": "John Doe",
- "description": "sample description",
- "level": [ ],
- "startDate": "2026-05-13",
- "endDate": "2026-05-13",
- "managerId": 12345,
- "managers": [ ],
- "enableCoachSearch": true,
- "enableAICoach": true,
- "enableNudges": true,
- "enableReminders": true,
- "enableRerports": true,
- "enableInternalCoachPool": true,
- "enableMarketplaceCoachPool": true,
- "programCode": "sample program code"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program manager info.
From routes/admin/programs.js — calls adminProgramsController.getProgramManagerInfo
Backed by controller adminProgramsController.getProgramManagerInfo.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates program preference.
From routes/admin/programs.js — calls adminProgramsController.updateProgramPreference
Backed by controller adminProgramsController.updateProgramPreference.
| programId | number Program ID |
| preferenceType | string Preference type field |
| value | any Value field |
{- "programId": 12345,
- "preferenceType": "sample preference type",
- "value": null
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates program manager.
From routes/admin/programs.js — calls adminProgramsController.updateProgramManager
Backed by controller adminProgramsController.updateProgramManager.
| programId | number Program ID |
| managerId | number Manager id (identifier) |
{- "programId": 12345,
- "managerId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates program end date.
From routes/admin/programs.js — calls adminProgramsController.updateProgramEndDate
Backed by controller adminProgramsController.updateProgramEndDate.
| programId | number Program ID |
| endDate | string <date> End date (ISO 8601) |
{- "programId": 12345,
- "endDate": "2026-05-13"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program tag info.
From routes/admin/programs.js — calls adminProgramsController.getProgramTagInfo
Backed by controller adminProgramsController.getProgramTagInfo.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program workflow templates.
From routes/admin/programs.js — calls adminProgramsController.getProgramWorkflowTemplates
Backed by controller adminProgramsController.getProgramWorkflowTemplates.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program component templates.
From routes/admin/programs.js — calls adminProgramsController.getProgramComponentTemplates
Backed by controller adminProgramsController.getProgramComponentTemplates.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program data.
From routes/admin/programs.js — calls adminProgramsController.getProgramData
Backed by controller adminProgramsController.getProgramData.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program statistics.
From routes/admin/programs.js — calls adminProgramsController.getProgramStatistics
Backed by controller adminProgramsController.getProgramStatistics.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program workflow.
From routes/admin/programs.js — calls adminProgramsController.getProgramWorkflow
Backed by controller adminProgramsController.getProgramWorkflow.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
{- "programId": 12345,
- "workflowId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program workflow progress.
From routes/admin/programs.js — calls adminProgramsController.getProgramWorkflowProgress
Backed by controller adminProgramsController.getProgramWorkflowProgress.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
{- "programId": 12345,
- "workflowId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates program workflow.
From routes/admin/programs.js — calls adminProgramsController.updateProgramWorkflow
Backed by controller adminProgramsController.updateProgramWorkflow.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
| workflowName | string Workflow name field |
| workflowStructure | Array of objects Workflow structure field |
{- "programId": 12345,
- "workflowId": 12345,
- "workflowName": "sample workflow name",
- "workflowStructure": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program workflow components.
From routes/admin/programs.js — calls adminProgramsController.getProgramWorkflowComponents
Backed by controller adminProgramsController.getProgramWorkflowComponents.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
{- "programId": 12345,
- "workflowId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates program workflow component.
From routes/admin/programs.js — calls adminProgramsController.updateProgramWorkflowComponent
Backed by controller adminProgramsController.updateProgramWorkflowComponent.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
| componentId | string <uuid> Component id (identifier) |
| componentType | string Component type field |
| componentName | string Component name field |
| componentDesc | string Component desc field |
| componentOrder | number Component order field |
| isSaved | boolean Is saved field |
| componentStructure | Array of objects Component structure field |
{- "programId": 12345,
- "workflowId": 12345,
- "componentId": "550e8400-e29b-41d4-a716-446655440000",
- "componentType": "sample component type",
- "componentName": "sample component name",
- "componentDesc": "sample component desc",
- "componentOrder": 1,
- "isSaved": true,
- "componentStructure": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Removes program workflow component.
From routes/admin/programs.js — calls adminProgramsController.removeProgramWorkflowComponent
Backed by controller adminProgramsController.removeProgramWorkflowComponent.
| componentId | string <uuid> Component id (identifier) |
| componentType | string Component type field |
{- "componentId": "550e8400-e29b-41d4-a716-446655440000",
- "componentType": "sample component type"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates workflow engagement.
From routes/admin/programs.js — calls adminProgramsController.createWorkflowEngagement
Backed by controller adminProgramsController.createWorkflowEngagement.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
| componentId | Array of strings Component id (identifier) |
| componentType | string Component type field |
| engagementName | string Engagement name |
| properties | Array of objects Properties field |
| learners | Array of objects Learners field |
| coaches | Array of objects Coaches field |
{- "programId": 12345,
- "workflowId": 12345,
- "componentId": [ ],
- "componentType": "sample component type",
- "engagementName": "Senior Director Cohort",
- "properties": [ ],
- "learners": [ ],
- "coaches": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits duplicate workflow engagement.
From routes/admin/programs.js — calls adminProgramsController.duplicateWorkflowEngagement
Backed by controller adminProgramsController.duplicateWorkflowEngagement.
| programId | number Program ID |
| engagementId | number Engagement ID |
{- "programId": 12345,
- "engagementId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates workflow engagement.
From routes/admin/programs.js — calls adminProgramsController.updateWorkflowEngagement
Backed by controller adminProgramsController.updateWorkflowEngagement.
| programId | number Program ID |
| componentId | Array of strings Component id (identifier) |
| componentType | string Component type field |
| engagementId | number Engagement ID |
| engagementName | string Engagement name |
| learners | Array of objects Learners field |
| coaches | Array of objects Coaches field |
{- "programId": 12345,
- "componentId": [ ],
- "componentType": "sample component type",
- "engagementId": 12345,
- "engagementName": "Senior Director Cohort",
- "learners": [ ],
- "coaches": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Removes workflow engagement.
From routes/admin/programs.js — calls adminProgramsController.removeWorkflowEngagement
Backed by controller adminProgramsController.removeWorkflowEngagement.
| programId | number Program ID |
| componentType | string Component type field |
| engagementId | number Engagement ID |
{- "programId": 12345,
- "componentType": "sample component type",
- "engagementId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates assessment engagement.
From routes/admin/programs.js — calls adminProgramsController.createAssessmentEngagement
Backed by controller adminProgramsController.createAssessmentEngagement.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
| componentId | Array of strings Component id (identifier) |
| engagementName | string Engagement name |
| assessmentLink | string Assessment link field |
| learners | Array of objects Learners field |
{- "programId": 12345,
- "workflowId": 12345,
- "componentId": [ ],
- "engagementName": "Senior Director Cohort",
- "assessmentLink": "sample assessment link",
- "learners": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates assessment engagement.
From routes/admin/programs.js — calls adminProgramsController.updateAssessmentEngagement
Backed by controller adminProgramsController.updateAssessmentEngagement.
| programId | number Program ID |
| engagementId | number Engagement ID |
| componentId | string <uuid> Component id (identifier) |
| engagementName | string Engagement name |
| assessmentLink | string Assessment link field |
| learners | Array of objects Learners field |
{- "programId": 12345,
- "engagementId": 12345,
- "componentId": "550e8400-e29b-41d4-a716-446655440000",
- "engagementName": "Senior Director Cohort",
- "assessmentLink": "sample assessment link",
- "learners": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates tool engagement.
From routes/admin/programs.js — calls adminProgramsController.createToolEngagement
Backed by controller adminProgramsController.createToolEngagement.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
| componentId | Array of strings Component id (identifier) |
| engagementName | string Engagement name |
| toolId | number Coaching tool ID |
| dueDate | string <date> Target completion date (ISO 8601) |
| learners | Array of objects Learners field |
{- "programId": 12345,
- "workflowId": 12345,
- "componentId": [ ],
- "engagementName": "Senior Director Cohort",
- "toolId": 12345,
- "dueDate": "2026-05-13",
- "learners": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates tool engagement.
From routes/admin/programs.js — calls adminProgramsController.updateToolEngagement
Backed by controller adminProgramsController.updateToolEngagement.
| programId | number Program ID |
| engagementId | number Engagement ID |
| componentId | string <uuid> Component id (identifier) |
| engagementName | string Engagement name |
| toolId | string <uuid> Coaching tool ID |
| dueDate | string <date> Target completion date (ISO 8601) |
| learners | Array of objects Learners field |
{- "programId": 12345,
- "engagementId": 12345,
- "componentId": "550e8400-e29b-41d4-a716-446655440000",
- "engagementName": "Senior Director Cohort",
- "toolId": "550e8400-e29b-41d4-a716-446655440000",
- "dueDate": "2026-05-13",
- "learners": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates meeting engagement.
From routes/admin/programs.js — calls adminProgramsController.createMeetingEngagement
Backed by controller adminProgramsController.createMeetingEngagement.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
| componentId | Array of strings Component id (identifier) |
| componentType | string Component type field |
| engagementName | string Engagement name |
| meetingType | string Meeting type field |
| learners | Array of objects Learners field |
| coaches | Array of objects Coaches field |
{- "programId": 12345,
- "workflowId": 12345,
- "componentId": [ ],
- "componentType": "sample component type",
- "engagementName": "Senior Director Cohort",
- "meetingType": "sample meeting type",
- "learners": [ ],
- "coaches": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Updates meeting engagement.
From routes/admin/programs.js — calls adminProgramsController.updateMeetingEngagement
Backed by controller adminProgramsController.updateMeetingEngagement.
| programId | number Program ID |
| engagementId | number Engagement ID |
| componentId | Array of strings Component id (identifier) |
| componentType | string Component type field |
| engagementName | string Engagement name |
| learners | Array of objects Learners field |
| coaches | Array of objects Coaches field |
{- "programId": 12345,
- "engagementId": 12345,
- "componentId": [ ],
- "componentType": "sample component type",
- "engagementName": "Senior Director Cohort",
- "learners": [ ],
- "coaches": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program members.
From routes/admin/programs.js — calls adminProgramsController.getProgramMembers
Backed by controller adminProgramsController.getProgramMembers.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program learners.
From routes/admin/programs.js — calls adminProgramsController.getProgramLearners
Backed by controller adminProgramsController.getProgramLearners.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program coaches.
From routes/admin/programs.js — calls adminProgramsController.getProgramCoaches
Backed by controller adminProgramsController.getProgramCoaches.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program facilitators.
From routes/admin/programs.js — calls adminProgramsController.getProgramFacilitators
Backed by controller adminProgramsController.getProgramFacilitators.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program tool list.
From routes/admin/programs.js — calls adminProgramsController.getProgramToolList
Backed by controller adminProgramsController.getProgramToolList.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits publish program workflow.
From routes/admin/programs.js — calls adminProgramsController.publishProgramWorkflow
Backed by controller adminProgramsController.publishProgramWorkflow.
| programId | number Program ID |
| workflowId | number Workflow id (identifier) |
{- "programId": 12345,
- "workflowId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program-wise sessions.
From routes/admin/programs.js — calls adminProgramsController.getProgramWiseSessions
Backed by controller adminProgramsController.getProgramWiseSessions.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves engagement-wise sessions.
From routes/admin/programs.js — calls adminProgramsController.getEngagementWiseSessions
Backed by controller adminProgramsController.getEngagementWiseSessions.
| programId | number Program ID |
| engagementId | number Engagement ID |
{- "programId": 12345,
- "engagementId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves mIS report.
From routes/admin/programs.js — calls adminProgramsController.getMISReport
Backed by controller adminProgramsController.getMISReport.
| programId | number Program ID |
| reportType | string Report type field |
{- "programId": 12345,
- "reportType": "sample report type"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Invites a user to session users.
From routes/admin/session.js — calls coachSessionController.inviteSessionUsers
Backed by controller coachSessionController.inviteSessionUsers.
| sessionId | number Session ID |
| sessionType | string Session type field |
| invitedUsers | Array of objects Invited users field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "invitedUsers": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves all sessions.
From routes/admin/session.js — calls adminSessionController.getAllSessions
Backed by controller adminSessionController.getAllSessions.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits view session details.
From routes/admin/session.js — calls adminSessionController.getSessionDetails
Backed by controller adminSessionController.getSessionDetails.
| sessionId | number Session ID |
| sessionType | string Session type field |
| componentType | string Component type field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "componentType": "sample component type"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves program-wise engagement list.
From routes/admin/session.js — calls adminSessionController.getProgramWiseEngagementList
Backed by controller adminSessionController.getProgramWiseEngagementList.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits add new session (group / meeting / 1-on-1 router by componentType). From routes/admin/session.js — branches to adminSessionController.addNewGroupSession (Group/Workshop), addNewMeeting (Meeting/Onboarding), or addNewSession (default 1-on-1)
| componentType | string Component type field |
| sessionType | string Session type field |
| sessionName | string Session name field |
| sessionDesc | string Session desc field |
| timezone | string Timezone field |
| startDateTime | string <date-time> Start date time field |
| endDateTime | string <date-time> End date time field |
| duration | number Duration field |
| sessionMode | number Session mode field |
| vcToolType | string Vc tool type field |
| vcToolLink | string Vc tool link field |
| location | string Location field |
| comment | string Comment field |
| coachId | number Coach's user ID |
| learnerId | number Learner's user ID |
| learners | Array of objects Learners field |
| engagementId | number Engagement ID |
| programId | number Program ID |
{- "componentType": "sample component type",
- "sessionType": "sample session type",
- "sessionName": "sample session name",
- "sessionDesc": "sample session desc",
- "timezone": "sample timezone",
- "startDateTime": "2026-05-13T09:00:00.000Z",
- "endDateTime": "2026-05-13T09:00:00.000Z",
- "duration": 1,
- "sessionMode": 1,
- "vcToolType": "sample vc tool type",
- "vcToolLink": "sample vc tool link",
- "location": "sample location",
- "comment": "sample comment",
- "coachId": 12345,
- "learnerId": 12345,
- "learners": [ ],
- "engagementId": 12345,
- "programId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits update session (group / meeting / 1-on-1 router by componentType). From routes/admin/session.js — branches to adminSessionController.updateGroupSession, updateMeetingSession, or updateSession by componentType
| sessionId | number Session ID |
| componentType | string Component type field |
| sessionType | string Session type field |
| userRole | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| sessionName | string Session name field |
| startDateTime | string <date-time> Start date time field |
| endDateTime | string <date-time> End date time field |
| timezone | string Timezone field |
| sessionMode | number Session mode field |
| vcToolType | string Vc tool type field |
| vcToolLink | string Vc tool link field |
| location | string Location field |
| comment | string Comment field |
{- "sessionId": 12345,
- "componentType": "sample component type",
- "sessionType": "sample session type",
- "userRole": "coach",
- "sessionName": "sample session name",
- "startDateTime": "2026-05-13T09:00:00.000Z",
- "endDateTime": "2026-05-13T09:00:00.000Z",
- "timezone": "sample timezone",
- "sessionMode": 1,
- "vcToolType": "sample vc tool type",
- "vcToolLink": "sample vc tool link",
- "location": "sample location",
- "comment": "sample comment"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits cancel session (group / meeting / 1-on-1 router by componentType). From routes/admin/session.js — branches to adminSessionController.cancelGroupSession, cancelMeetingSession, or coachSessionController.cancelSession
| sessionId | number Session ID |
| componentType | string Component type field |
| sessionType | string Session type field |
| userRole | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| comment | string Comment field |
| userId | number Internal user ID (foreign key) |
{- "sessionId": 12345,
- "componentType": "sample component type",
- "sessionType": "sample session type",
- "userRole": "coach",
- "comment": "sample comment",
- "userId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits manager accept group session request (legacy — no admin UI hook).
From routes/admin/session.js — calls adminSessionController.managerAcceptGroupSessionRequest. Per project memory, no admin-accepts-session UI flow exists; controller is dead legacy.
Backed by controller adminSessionController.managerAcceptGroupSessionRequest..
| sessionId | number Session ID |
{- "sessionId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits mark session as completed (Admin role).
From routes/admin/session.js — calls adminSessionController.markSessionCompleted (userRole forced to "Admin")
Backed by controller adminSessionController.markSessionCompleted.
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves connected learners.
From routes/admin/session.js — calls adminSessionController.connectedLearners
Backed by controller adminSessionController.connectedLearners.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected coaches.
From routes/admin/session.js — calls adminSessionController.connectedCoaches
Backed by controller adminSessionController.connectedCoaches.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves invite link.
From routes/admin/user_management.js — calls userManagementController.getInviteLink
Backed by controller userManagementController.getInviteLink.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates member.
From routes/admin/user_management.js — calls userManagementController.addMember
Backed by controller userManagementController.addMember.
| id | number Generic identifier |
| name | string Display name |
string <email> Email address | |
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| programId | number Program ID |
| corporateId | number Corporate (account) ID |
| createdBy | number Created by field |
| activationStatus | string Activation status field |
{- "id": 12345,
- "name": "John Doe",
- "email": "user@example.com",
- "role": "coach",
- "programId": 12345,
- "corporateId": 12345,
- "createdBy": 1,
- "activationStatus": "sample activation status"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates user for invited member (public — no auth).
From routes/admin/user_management.js — calls userManagementController.addInvitedMember. No verifyToken middleware.
Backed by controller userManagementController.addInvitedMember..
| name | string Display name |
| emailId | string <email> Email address |
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| password | string User password (plaintext at API boundary; hashed server-side) |
| isInvited | boolean Is invited field |
| programId | number Program ID |
| accountId | string <uuid> Account id (identifier) |
{- "name": "John Doe",
- "emailId": "user@example.com",
- "role": "coach",
- "password": "Pa$$w0rd123",
- "isInvited": true,
- "programId": 12345,
- "accountId": "550e8400-e29b-41d4-a716-446655440000"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Uploads members.
From routes/admin/user_management.js — calls userManagementController.uploadMember
Backed by controller userManagementController.uploadMember.
{ }{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves export members.
From routes/admin/user_management.js — calls userManagementController.exportMembers
Backed by controller userManagementController.exportMembers.
{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Removes member.
From routes/admin/user_management.js — calls userManagementController.removeMember
Backed by controller userManagementController.removeMember.
| emailId | string <email> Email address |
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
{- "emailId": "user@example.com",
- "role": "coach"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves all members.
From routes/admin/user_management.js — calls userManagementController.allMembers
Backed by controller userManagementController.allMembers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Sends reminder.
From routes/admin/user_management.js — calls userManagementController.sendReminder
Backed by controller userManagementController.sendReminder.
| emailId | string <email> Email address |
{- "emailId": "user@example.com"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Sends bulk reminder.
From routes/admin/user_management.js — calls userManagementController.sendBulkReminder
Backed by controller userManagementController.sendBulkReminder.
| emailIds | Array of strings Email ids field |
{- "emailIds": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits activate member.
From routes/admin/user_management.js — calls userManagementController.activateMember
Backed by controller userManagementController.activateMember.
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| userId | number Internal user ID (foreign key) |
| corporateId | number Corporate (account) ID |
{- "role": "coach",
- "userId": 12345,
- "corporateId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits deactivate member.
From routes/admin/user_management.js — calls userManagementController.deactivateMember
Backed by controller userManagementController.deactivateMember.
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| userId | number Internal user ID (foreign key) |
| corporateId | number Corporate (account) ID |
{- "role": "coach",
- "userId": 12345,
- "corporateId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits activate account.
From routes/admin/user_management.js — calls userManagementController.activateAccount
Backed by controller userManagementController.activateAccount.
| corporateId | number Corporate (account) ID |
{- "corporateId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Submits deactivate account.
From routes/admin/user_management.js — calls userManagementController.deactivateAccount
Backed by controller userManagementController.deactivateAccount.
| corporateId | number Corporate (account) ID |
{- "corporateId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Creates new account.
From routes/admin/user_management.js — calls userManagementController.addNewAccount
Backed by controller userManagementController.addNewAccount.
| corporateId | number Corporate (account) ID |
| accountName | string Account name field |
| adminName | string Admin name field |
| adminEmail | string <email> Admin email field |
| adminUserId | number Admin user id (identifier) |
| adminAuthId | string <uuid> Admin auth id (identifier) |
| adminActivationStatus | string Admin activation status field |
| createdBy | number Created by field |
| website | string Website field |
| address | string Address field |
| adminRole | string Admin role field |
| licensePlan | string License plan field |
| billingType | string Billing type field |
| serviceTypes | Array of strings Service types field |
{- "corporateId": 12345,
- "accountName": "sample account name",
- "adminName": "sample admin name",
- "adminEmail": "user@example.com",
- "adminUserId": 12345,
- "adminAuthId": "550e8400-e29b-41d4-a716-446655440000",
- "adminActivationStatus": "sample admin activation status",
- "createdBy": 1,
- "website": "sample website",
- "address": "sample address",
- "adminRole": "sample admin role",
- "licensePlan": "sample license plan",
- "billingType": "sample billing type",
- "serviceTypes": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves accounts list.
From routes/admin/user_management.js — calls userManagementController.getAccountsList
Backed by controller userManagementController.getAccountsList.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates account info.
From routes/admin/user_management.js — calls userManagementController.updateAccountInfo
Backed by controller userManagementController.updateAccountInfo.
| corporateId | number Corporate (account) ID |
| adminUserId | number Admin user id (identifier) |
| accountName | string Account name field |
| website | string Website field |
| address | string Address field |
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| licensePlan | string License plan field |
| billingType | string Billing type field |
| serviceTypes | Array of strings Service types field |
{- "corporateId": 12345,
- "adminUserId": 12345,
- "accountName": "sample account name",
- "website": "sample website",
- "address": "sample address",
- "role": "coach",
- "licensePlan": "sample license plan",
- "billingType": "sample billing type",
- "serviceTypes": [ ]
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves account info.
From routes/admin/user_management.js — calls userManagementController.getAccountInfo
Backed by controller userManagementController.getAccountInfo.
| corporateId | number Corporate (account) ID |
{- "corporateId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves all accounts info.
From routes/admin/user_management.js — calls userManagementController.getAllAccountsInfo
Backed by controller userManagementController.getAllAccountsInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves account-wise members.
From routes/admin/user_management.js — calls userManagementController.getAccountWiseMembers
Backed by controller userManagementController.getAccountWiseMembers.
| corporateId | number Corporate (account) ID |
{- "corporateId": 12345
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves role-wise account members.
From routes/admin/user_management.js — calls userManagementController.getRoleWiseAccountMembers
Backed by controller userManagementController.getRoleWiseAccountMembers.
| corporateId | number Corporate (account) ID |
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
{- "corporateId": 12345,
- "role": "coach"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Sends appreciation.
From routes/admin/user_management.js — calls userManagementController.sendAppreciation
Backed by controller userManagementController.sendAppreciation.
| learnerList | string Learner list field |
{- "learnerList": "sample learner list"
}{- "result": "FAILURE",
- "message": "Server error",
- "error": {
- "code": "INTERNAL_ERROR"
}
}Retrieves actions for a user.
From routes/coach/actions.js - calls coachActionController.getUserActions with userRole=Coach
Backed by controller coachActionController.getUserActions.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
{- "userId": 12345,
- "coachId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a new action.
From routes/coach/actions.js - calls coachActionController.addAction with userRole=Coach, isShared=true
Backed by controller coachActionController.addAction.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
| actionId | number Action ID |
| actionName | string Action name field |
| dueDate | string <date> Target completion date (ISO 8601) |
| progress | number Progress percentage (0-100) |
| description | string Description field |
| goalId | number Goal ID |
| isShared | boolean Is shared field |
| competencies | Array of objects Competencies field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "userId": 12345,
- "coachId": 12345,
- "actionId": 12345,
- "actionName": "sample action name",
- "dueDate": "2026-05-13",
- "progress": 50,
- "description": "sample description",
- "goalId": 12345,
- "isShared": true,
- "competencies": [ ],
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates an action.
From routes/coach/actions.js - calls coachActionController.updateAction
Backed by controller coachActionController.updateAction.
| actionId | number Action ID |
| actionName | string Action name field |
| dueDate | string <date> Target completion date (ISO 8601) |
| progress | number Progress percentage (0-100) |
{- "actionId": 12345,
- "actionName": "sample action name",
- "dueDate": "2026-05-13",
- "progress": 50
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates competencies linked to an action.
From routes/coach/actions.js - calls coachActionController.updateActionCompetencies
Backed by controller coachActionController.updateActionCompetencies.
| actionId | number Action ID |
| competencies | Array of objects Competencies field |
{- "actionId": 12345,
- "competencies": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a group action (for multiple coachees).
From routes/coach/actions.js - calls coachActionController.addGroupAction
Backed by controller coachActionController.addGroupAction.
| actionName | string Action name field |
| dueDate | string <date> Target completion date (ISO 8601) |
| description | string Description field |
| engagementId | number Engagement ID |
| sessionId | number Session ID |
| coacheeIds | Array of objects Coachee ids field |
{- "actionName": "sample action name",
- "dueDate": "2026-05-13",
- "description": "sample description",
- "engagementId": 12345,
- "sessionId": 12345,
- "coacheeIds": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves details of an action.
From routes/coach/actions.js - calls coachActionController.getActionDetails
Backed by controller coachActionController.getActionDetails.
| actionId | number Action ID |
{- "actionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes an action.
From routes/coach/actions.js - calls coachActionController.DeleteAction
Backed by controller coachActionController.DeleteAction.
| actionId | number Action ID |
{- "actionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a comment to an action.
From routes/coach/actions.js - calls coachActionController.AddComment
Backed by controller coachActionController.AddComment.
| actionId | number Action ID |
| sendToAll | boolean Send to all field |
| comment | string Comment field |
{- "actionId": 12345,
- "sendToAll": true,
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark an action as completed.
From routes/coach/actions.js - calls coachActionController.MarkActionCompleted
Backed by controller coachActionController.MarkActionCompleted.
| actionId | number Action ID |
{- "actionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a subtask under an action.
From routes/coach/actions.js - calls coachActionController.CreateActionSubtask
Backed by controller coachActionController.CreateActionSubtask.
| actionId | number Action ID |
| taskName | string Task name field |
| taskDesc | string Task desc field |
| actionTaskId | number Action task id (identifier) |
{- "actionId": 12345,
- "taskName": "sample task name",
- "taskDesc": "sample task desc",
- "actionTaskId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark a task as completed.
From routes/coach/actions.js - calls coachActionController.MarkTaskCompleted
Backed by controller coachActionController.MarkTaskCompleted.
| actionTaskId | number Action task id (identifier) |
{- "actionTaskId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a task.
From routes/coach/actions.js - calls coachActionController.DeleteTask
Backed by controller coachActionController.DeleteTask.
| actionTaskId | number Action task id (identifier) |
{- "actionTaskId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Uploads a resource file to an action.
From routes/coach/actions.js - calls coachActionController.UploadResource
Backed by controller coachActionController.UploadResource.
| actionId | number Action ID |
| resourceName | string Resource name field |
| fileName | string File name field |
| filePath | string File path field |
| fileSize | number File size field |
{- "actionId": 12345,
- "resourceName": "sample resource name",
- "fileName": "sample file name",
- "filePath": "sample file path",
- "fileSize": 1
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a resource from an action.
From routes/coach/actions.js - calls coachActionController.DeleteResource
Backed by controller coachActionController.DeleteResource.
| resourceId | number Resource id (identifier) |
{- "resourceId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a hyperlink to an action.
From routes/coach/actions.js - calls coachActionController.UploadActionLink
Backed by controller coachActionController.UploadActionLink.
| actionId | number Action ID |
| linkName | string Link name field |
| actionLink | string Action link field |
| actionLinkId | number Action link id (identifier) |
{- "actionId": 12345,
- "linkName": "sample link name",
- "actionLink": "sample action link",
- "actionLinkId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a link from an action.
From routes/coach/actions.js - calls coachActionController.DeleteActionLink
Backed by controller coachActionController.DeleteActionLink.
| actionLinkId | number Action link id (identifier) |
{- "actionLinkId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach group engagements info.
From routes/coach/actions.js - calls coachActionController.GetGroupEngagementsInfo
Backed by controller coachActionController.GetGroupEngagementsInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a follower to an action (not yet used).
From routes/coach/actions.js - calls coachActionController.AddFollowerToAction
Backed by controller coachActionController.AddFollowerToAction.
| actionId | number Action ID |
| followerName | string Follower name field |
| followerEmail | string <email> Follower email field |
{- "actionId": 12345,
- "followerName": "sample follower name",
- "followerEmail": "user@example.com"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a follower from an action (not yet used).
From routes/coach/actions.js - calls coachActionController.DeleteFollowerFromAction
Backed by controller coachActionController.DeleteFollowerFromAction.
| actionId | number Action ID |
| followerId | number Follower id (identifier) |
{- "actionId": 12345,
- "followerId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits inform coach about an action (not yet used).
From routes/coach/actions.js - calls coachActionController.UpdateCoachForAction
Backed by controller coachActionController.UpdateCoachForAction.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits inform coachee about an action (not yet used).
From routes/coach/actions.js - calls coachActionController.UpdateCoacheeForAction
Backed by controller coachActionController.UpdateCoacheeForAction.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user engagement program info (not yet used).
From routes/coach/actions.js - calls coachActionController.GetUserEngagementProgramInfo
Backed by controller coachActionController.GetUserEngagementProgramInfo.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves group engagement program info (not yet used).
From routes/coach/actions.js - calls coachActionController.GetGroupEngagementProgramInfo
Backed by controller coachActionController.GetGroupEngagementProgramInfo.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a stakeholder (not yet used).
From routes/coach/actions.js - calls coachActionController.AddStakeHolder
Backed by controller coachActionController.AddStakeHolder.
| userDetails | string User details field |
{- "userDetails": "sample user details"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves stakeholder info (not yet used).
From routes/coach/actions.js - calls coachActionController.GetStakeHolderInfo
Backed by controller coachActionController.GetStakeHolderInfo.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves group actions (not yet used).
From routes/coach/actions.js - calls coachActionController.GetGroupActions
Backed by controller coachActionController.GetGroupActions.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits feedback on an action.
From routes/coach/actions.js - calls coachActionController.submitActionFeedback with userRole=Coach
Backed by controller coachActionController.submitActionFeedback.
| actionId | number Action ID |
| rating | number Rating field |
| objectivity | number Objectivity field |
| efficiency | number Efficiency field |
| quality | number Quality field |
| accuracy | number Accuracy field |
| feedback | string Feedback field |
{- "actionId": 12345,
- "rating": 1,
- "objectivity": 1,
- "efficiency": 1,
- "quality": 1,
- "accuracy": 1,
- "feedback": "sample feedback"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates or update a goal.
From routes/coach/actions.js - calls coachActionController.AddUpdateGoal with isShared=true
Backed by controller coachActionController.AddUpdateGoal.
| userId | number Internal user ID (foreign key) |
| goalId | number Goal ID |
| programId | number Program ID |
| description | string Description field |
| comment | string Comment field |
| isShared | boolean Is shared field |
| goalName | string Goal name field |
| dueDate | string <date> Target completion date (ISO 8601) |
| progress | number Progress percentage (0-100) |
{- "userId": 12345,
- "goalId": 12345,
- "programId": 12345,
- "description": "sample description",
- "comment": "sample comment",
- "isShared": true,
- "goalName": "sample goal name",
- "dueDate": "2026-05-13",
- "progress": 50
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates progress on a goal.
From routes/coach/actions.js - calls coachActionController.UpdateGoalProgress
Backed by controller coachActionController.UpdateGoalProgress.
| goalId | number Goal ID |
| progress | number Progress percentage (0-100) |
{- "goalId": 12345,
- "progress": 50
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a comment to a goal.
From routes/coach/actions.js - calls coachActionController.AddGoalComment with isShared=true
Backed by controller coachActionController.AddGoalComment.
| goalId | number Goal ID |
| comment | string Comment field |
| isShared | boolean Is shared field |
{- "goalId": 12345,
- "comment": "sample comment",
- "isShared": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users (GET variant).
From routes/coach/connection.js - calls coachConnectionController.getConnectedUsers with userRole=Coach
Backed by controller coachConnectionController.getConnectedUsers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users (POST variant).
From routes/coach/connection.js - calls coachConnectionController.getConnectedUsers with userRole=Coach
Backed by controller coachConnectionController.getConnectedUsers.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user details for a connection.
From routes/coach/connection.js - calls coachConnectionController.getUserDetails with userRole=Coach
Backed by controller coachConnectionController.getUserDetails.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves upcoming sessions for a connected user.
From routes/coach/connection.js - calls coachConnectionController.getUserUpcomingSessions with userRole=Coach
Backed by controller coachConnectionController.getUserUpcomingSessions.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves pending activities for a connected user.
From routes/coach/connection.js - calls coachConnectionController.getUserPendingActivities with userRole=Coach
Backed by controller coachConnectionController.getUserPendingActivities.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all sessions for a connected user.
From routes/coach/connection.js - calls coachConnectionController.getUserSessions with userRole=Coach
Backed by controller coachConnectionController.getUserSessions.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all sessions for the coach.
From routes/coach/connection.js - calls coachConnectionController.getAllSessions with userRole=Coach
Backed by controller coachConnectionController.getAllSessions.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves goals for a connected user.
From routes/coach/connection.js - calls coachConnectionController.getUserGoals with userRole=Coach
Backed by controller coachConnectionController.getUserGoals.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
{- "userId": 12345,
- "coachId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves comments on a goal.
From routes/coach/connection.js - calls coachConnectionController.getGoalComments
Backed by controller coachConnectionController.getGoalComments.
| goalId | number Goal ID |
{- "goalId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves calculate coach profile completeness percentage.
From routes/coach/home.js - calls coachHomeController.getProfileCompletePercentage
Backed by controller coachHomeController.getProfileCompletePercentage.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users (GET variant).
From routes/coach/home.js - calls coachHomeController.getConnectedUsers with userRole=Coach
Backed by controller coachHomeController.getConnectedUsers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users (POST variant).
From routes/coach/home.js - calls coachHomeController.getConnectedUsers with userRole=Coach
Backed by controller coachHomeController.getConnectedUsers.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves details of a single connected user.
From routes/coach/home.js - calls coachHomeController.getUserDetails with userRole=Coach
Backed by controller coachHomeController.getUserDetails.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves upcoming sessions for coach.
From routes/coach/home.js - calls coachHomeController.getUpcomingSessions with userRole=Coach
Backed by controller coachHomeController.getUpcomingSessions.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves pending activities for coach.
From routes/coach/home.js - calls coachHomeController.getPendingActivities with userRole=Coach
Backed by controller coachHomeController.getPendingActivities.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach engagements (programs).
From routes/coach/home.js - calls coachHomeController.getUserEngagements
Backed by controller coachHomeController.getUserEngagements.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user calendar availabilities (new).
From routes/coach/home.js - calls coachHomeController.getUsersAvailabilitiesNew
Backed by controller coachHomeController.getUsersAvailabilitiesNew.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user goals (called from home/dashboard).
From routes/coach/home.js - calls coachHomeController.getUserGoals with userRole=Coach
Backed by controller coachHomeController.getUserGoals.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
{- "userId": 12345,
- "coachId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Checks whether session feedback was given.
From routes/coach/home.js - calls coachHomeController.isSessionFeedbackGiven with userRole=Coach
Backed by controller coachHomeController.isSessionFeedbackGiven.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves should platform feedback dialog be shown.
From routes/coach/home.js - calls coachHomeController.showPlatformFeedback
Backed by controller coachHomeController.showPlatformFeedback.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits platform feedback (NPS / rating).
From routes/coach/home.js - calls coachHomeController.submitPlatformFeedback
Backed by controller coachHomeController.submitPlatformFeedback.
| rating | boolean Rating field |
| feedback | string Feedback field |
| easeOfUsage | boolean Ease of usage field |
| usefullness | boolean Usefullness field |
| goalAchievement | boolean Goal achievement field |
| progress | boolean Progress percentage (0-100) |
| valueOfTime | boolean Value of time field |
| valueOfService | boolean Value of service field |
{- "rating": true,
- "feedback": "sample feedback",
- "easeOfUsage": true,
- "usefullness": true,
- "goalAchievement": true,
- "progress": true,
- "valueOfTime": true,
- "valueOfService": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits view a coaching tool report from coach home.
From routes/coach/home.js - calls coachHomeController.viewReport
Backed by controller coachHomeController.viewReport.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves insights filter options.
From routes/coach/insights.js - calls coachInsightsController.getFilterData (aggregates programs, corporates, connected users)
Backed by controller coachInsightsController.getFilterData.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves list of programs the coach is part of.
From routes/coach/insights.js - calls coachInsightsController.getUserPrograms
Backed by controller coachInsightsController.getUserPrograms.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves list of corporates the coach is part of.
From routes/coach/insights.js - calls coachInsightsController.getUserCoprorateInfo
Backed by controller coachInsightsController.getUserCoprorateInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users for insights filter.
From routes/coach/insights.js - calls coachInsightsController.getConnectedUsers
Backed by controller coachInsightsController.getConnectedUsers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach insights statistics.
From routes/coach/insights.js - calls coachInsightsController.getCoachInsightStatistics
Backed by controller coachInsightsController.getCoachInsightStatistics.
| userId | number Internal user ID (foreign key) |
| programId | number Program ID |
| corporateId | number Corporate (account) ID |
| startDate | string <date> Start date (ISO 8601) |
| endDate | string <date> End date (ISO 8601) |
{- "userId": 12345,
- "programId": 12345,
- "corporateId": 12345,
- "startDate": "2026-05-13",
- "endDate": "2026-05-13"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves insights data (same handler as coach_insights).
From routes/coach/insights.js - calls coachInsightsController.getCoachInsightStatistics
Backed by controller coachInsightsController.getCoachInsightStatistics.
| userId | number Internal user ID (foreign key) |
| programId | number Program ID |
| corporateId | number Corporate (account) ID |
| startDate | string <date> Start date (ISO 8601) |
| endDate | string <date> End date (ISO 8601) |
{- "userId": 12345,
- "programId": 12345,
- "corporateId": 12345,
- "startDate": "2026-05-13",
- "endDate": "2026-05-13"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves facilitation service basic details.
From routes/coach/settings/internalCoachServices.js - calls getFacilitationBasicDetails
Backed by controller getFacilitationBasicDetails.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates or update facilitation service basic details.
From routes/coach/settings/internalCoachServices.js - calls updateFacilitationBasicDetails. Zod validated.
Backed by controller updateFacilitationBasicDetails..
| totalYearsExperience | number Total years experience field |
| highestLearnerLevel | number Highest learner level field |
| totalProgramsFacilitated | number Total programs facilitated field |
{- "totalYearsExperience": 1,
- "highestLearnerLevel": 1,
- "totalProgramsFacilitated": 1
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all certifications.
From routes/coach/settings/internalCoachServices.js - calls getCertifications
Backed by controller getCertifications.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a new certification (multipart with optional file).
From routes/coach/settings/internalCoachServices.js - calls createCertification. Uses multer multipart upload to S3, Zod validated.
Backed by controller createCertification..
| name | string Display name |
| organization | string Organization field |
| validFrom | string <date> Valid from field |
| validTo | string <date> Valid to field |
| folder | string Folder field |
| file | string <binary> File field |
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates a certification (multipart with optional file).
From routes/coach/settings/internalCoachServices.js - calls updateCertification. Path param id (positive int).
Backed by controller updateCertification..
| id required | string |
| name | string Display name |
| organization | string Organization field |
| validFrom | string <date> Valid from field |
| validTo | string <date> Valid to field |
| folder | string Folder field |
| file | string <binary> File field |
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a certification.
From routes/coach/settings/internalCoachServices.js - calls deleteCertification
Backed by controller deleteCertification.
| id required | string |
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits copy / duplicate a certification.
From routes/coach/settings/internalCoachServices.js - calls copyCertification
Backed by controller copyCertification.
| id required | string |
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all memberships.
From routes/coach/settings/internalCoachServices.js - calls getMemberships
Backed by controller getMemberships.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a new membership (multipart with optional file).
From routes/coach/settings/internalCoachServices.js - calls createMembership. Multer + Zod.
Backed by controller createMembership..
| membershipBody | string Membership body field |
| membershipName | string Membership name field |
| validFrom | string <date> Valid from field |
| validTo | string <date> Valid to field |
| folder | string Folder field |
| file | string <binary> File field |
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates a membership (multipart with optional file).
From routes/coach/settings/internalCoachServices.js - calls updateMembership
Backed by controller updateMembership.
| id required | string |
| membershipBody | string Membership body field |
| membershipName | string Membership name field |
| validFrom | string <date> Valid from field |
| validTo | string <date> Valid to field |
| folder | string Folder field |
| file | string <binary> File field |
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a membership.
From routes/coach/settings/internalCoachServices.js - calls deleteMembership
Backed by controller deleteMembership.
| id required | string |
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits copy / duplicate a membership.
From routes/coach/settings/internalCoachServices.js - calls copyMembership
Backed by controller copyMembership.
| id required | string |
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all signature programs.
From routes/coach/settings/internalCoachServices.js - calls getSignaturePrograms
Backed by controller getSignaturePrograms.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a new signature program.
From routes/coach/settings/internalCoachServices.js - calls createSignatureProgram. Zod validated.
Backed by controller createSignatureProgram..
| programName | string Program name |
| organization | string Organization field |
| audienceLevel | number Audience level field |
| focusArea | string Focus area field |
| behavioralSkills | Array of strings Behavioral skills field |
| functionalSkills | Array of strings Functional skills field |
| technicalSkills | Array of strings Technical skills field |
{- "programName": "Q3 Leadership Cohort",
- "organization": "sample organization",
- "audienceLevel": 1,
- "focusArea": "sample focus area",
- "behavioralSkills": [ ],
- "functionalSkills": [ ],
- "technicalSkills": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates a signature program.
From routes/coach/settings/internalCoachServices.js - calls updateSignatureProgram
Backed by controller updateSignatureProgram.
| id required | string |
| programName | string Program name |
| organization | string Organization field |
| audienceLevel | number Audience level field |
| focusArea | string Focus area field |
| behavioralSkills | Array of strings Behavioral skills field |
| functionalSkills | Array of strings Functional skills field |
| technicalSkills | Array of strings Technical skills field |
{- "programName": "Q3 Leadership Cohort",
- "organization": "sample organization",
- "audienceLevel": 1,
- "focusArea": "sample focus area",
- "behavioralSkills": [ ],
- "functionalSkills": [ ],
- "technicalSkills": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a signature program.
From routes/coach/settings/internalCoachServices.js - calls deleteSignatureProgram
Backed by controller deleteSignatureProgram.
| id required | string |
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits copy / duplicate a signature program.
From routes/coach/settings/internalCoachServices.js - calls copySignatureProgram
Backed by controller copySignatureProgram.
| id required | string |
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves engagement notes for a user.
From routes/coach/notes.js - calls coachNoteController.GetEngagementNotes
Backed by controller coachNoteController.GetEngagementNotes.
| engagementId | number Engagement ID |
| engagementType | string Engagement type field |
{- "engagementId": 12345,
- "engagementType": "sample engagement type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves notes attached to a session.
From routes/coach/notes.js - calls coachNoteController.GetSessionNotes
Backed by controller coachNoteController.GetSessionNotes.
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a note.
From routes/coach/notes.js - calls coachNoteController.AddUpdateNote
Backed by controller coachNoteController.AddUpdateNote.
| noteId | number Note ID |
| noteType | string Note type field |
| noteTitle | string Note title field |
| textNote | string Text note field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "noteId": 12345,
- "noteType": "sample note type",
- "noteTitle": "sample note title",
- "textNote": "sample text note",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates a note (same handler as add_note).
From routes/coach/notes.js - calls coachNoteController.AddUpdateNote
Backed by controller coachNoteController.AddUpdateNote.
| noteId | number Note ID |
| noteType | string Note type field |
| noteTitle | string Note title field |
| textNote | string Text note field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "noteId": 12345,
- "noteType": "sample note type",
- "noteTitle": "sample note title",
- "textNote": "sample text note",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates note summary text.
From routes/coach/notes.js - calls coachNoteController.updateNoteSummary
Backed by controller coachNoteController.updateNoteSummary.
| noteId | number Note ID |
| noteSummary | string Note summary field |
{- "noteId": 12345,
- "noteSummary": "sample note summary"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a note.
From routes/coach/notes.js - calls coachNoteController.DeleteNote
Backed by controller coachNoteController.DeleteNote.
| noteId | number Note ID |
{- "noteId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Uploads a voice note resource (resourceType=VOICE).
From routes/coach/notes.js - calls coachNoteController.UploadNoteResource with resourceType=VOICE
Backed by controller coachNoteController.UploadNoteResource.
| resourceTitle | string Resource title field |
| fileName | string File name field |
| filePath | string File path field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "resourceTitle": "sample resource title",
- "fileName": "sample file name",
- "filePath": "sample file path",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Uploads a file resource (resourceType=FILE).
From routes/coach/notes.js - calls coachNoteController.UploadNoteResource with resourceType=FILE
Backed by controller coachNoteController.UploadNoteResource.
| resourceTitle | string Resource title field |
| fileName | string File name field |
| filePath | string File path field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "resourceTitle": "sample resource title",
- "fileName": "sample file name",
- "filePath": "sample file path",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates profile image.
From routes/coach/profile.js — calls coachProfileController.updateProfileImage
Backed by controller coachProfileController.updateProfileImage.
| profileImage | string Profile image field |
{- "profileImage": "sample profile image"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves education info.
From routes/coach/profile.js — calls coachProfileController.educationInfo
Backed by controller coachProfileController.educationInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates education info.
From routes/coach/profile.js — calls coachProfileController.addEducationInfo
Backed by controller coachProfileController.addEducationInfo.
| educationInfo | Array of objects Education info field |
{- "educationInfo": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes education info.
From routes/coach/profile.js — calls coachProfileController.removeEducationInfo
Backed by controller coachProfileController.removeEducationInfo.
| studyField | string Study field field |
| qualification | string Qualification field |
| university | string University field |
{- "studyField": "sample study field",
- "qualification": "sample qualification",
- "university": "sample university"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves corporate experience info.
From routes/coach/profile.js — calls coachProfileController.getUserCorporateInfo
Backed by controller coachProfileController.getUserCorporateInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates corporate experience info.
From routes/coach/profile.js — calls coachProfileController.updateUserCorporateInfo
Backed by controller coachProfileController.updateUserCorporateInfo.
| corporateExp | number Corporate exp field |
| corporateExpYear | number Corporate exp year field |
| corporateExpMonth | number Corporate exp month field |
| industries | Array of objects Industries field |
| functions | Array of objects Functions field |
| currentRole | number Current role field |
| designation | string Designation field |
| organizationsWorked | Array of objects Organizations worked field |
{- "corporateExp": 1,
- "corporateExpYear": 1,
- "corporateExpMonth": 1,
- "industries": [ ],
- "functions": [ ],
- "currentRole": 1,
- "designation": "sample designation",
- "organizationsWorked": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates organization info.
From routes/coach/profile.js — calls coachProfileController.addOrganizationInfo
Backed by controller coachProfileController.addOrganizationInfo.
| organizationsWorked | Array of objects Organizations worked field |
{- "organizationsWorked": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes organization info.
From routes/coach/profile.js — calls coachProfileController.removeOrganizationInfo
Backed by controller coachProfileController.removeOrganizationInfo.
| organizationName | string Organization name field |
{- "organizationName": "sample organization name"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach bio.
From routes/coach/profile.js — calls coachProfileController.getUserBio
Backed by controller coachProfileController.getUserBio.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coach bio.
From routes/coach/profile.js — calls coachProfileController.updateUserBio
Backed by controller coachProfileController.updateUserBio.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coaching service data.
From routes/coach/profile.js — calls coachProfileController.coachingService
Backed by controller coachProfileController.coachingService.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coaching service - section 1 (certifications).
From routes/coach/profile.js — calls coachProfileController.updateCoachingServiceSec1
Backed by controller coachProfileController.updateCoachingServiceSec1.
| coachingCertificationEnabled | boolean Coaching certification enabled field |
| coachingCredentialEnabled | boolean Coaching credential enabled field |
| certifications | Array of objects Certifications field |
| credentials | Array of objects Credentials field |
{- "coachingCertificationEnabled": true,
- "coachingCredentialEnabled": true,
- "certifications": [ ],
- "credentials": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coaching service - section 2 (experience).
From routes/coach/profile.js — calls coachProfileController.updateCoachingServiceSec2
Backed by controller coachProfileController.updateCoachingServiceSec2.
| coachingExperience | number Coaching experience field |
| coachingHours | number Coaching hours field |
| clientsCoached | number Clients coached field |
| clientsCoachedLevel | number Clients coached level field |
| coachingSkills | Array of objects Coaching skills field |
| isGroupCoachingExperienced | boolean Is group coaching experienced field |
| isSupervisionExperienced | boolean Is supervision experienced field |
| clientCoached | Array of objects Client coached field |
{- "coachingExperience": 1,
- "coachingHours": 1,
- "clientsCoached": 1,
- "clientsCoachedLevel": 1,
- "coachingSkills": [ ],
- "isGroupCoachingExperienced": true,
- "isSupervisionExperienced": true,
- "clientCoached": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coaching service - section 3 (delivery mode).
From routes/coach/profile.js — calls coachProfileController.updateCoachingServiceSec3
Backed by controller coachProfileController.updateCoachingServiceSec3.
| deliveryMode | number Delivery mode field |
| openToInPersonSession | boolean Open to in person session field |
| openToTravelSameCity | boolean Open to travel same city field |
| openToTravelOtherCity | boolean Open to travel other city field |
| openToTravelOverseas | boolean Open to travel overseas field |
{- "deliveryMode": 1,
- "openToInPersonSession": true,
- "openToTravelSameCity": true,
- "openToTravelOtherCity": true,
- "openToTravelOverseas": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates coaching fee.
From routes/coach/profile.js — calls coachProfileController.updateCoachingFeeInfo with actionType=Add
Backed by controller coachProfileController.updateCoachingFeeInfo.
| sessionType | string Session type field |
| coachingFeeInfo | object Coaching fee info field |
{- "sessionType": "sample session type",
- "coachingFeeInfo": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes coaching fee.
From routes/coach/profile.js — calls coachProfileController.updateCoachingFeeInfo with actionType=Remove
Backed by controller coachProfileController.updateCoachingFeeInfo.
| sessionType | string Session type field |
| coachingFeeInfo | object Coaching fee info field |
{- "sessionType": "sample session type",
- "coachingFeeInfo": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves facilitation service data.
From routes/coach/profile.js — calls coachProfileController.facilitationService
Backed by controller coachProfileController.facilitationService.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates facilitation service - section 1 (certifications).
From routes/coach/profile.js — calls coachProfileController.updateFacilitationServiceSec1
Backed by controller coachProfileController.updateFacilitationServiceSec1.
| facilitationCertificationEnabled | boolean Facilitation certification enabled field |
| facilitationCredentialEnabled | boolean Facilitation credential enabled field |
| certifications | Array of objects Certifications field |
| credentials | Array of objects Credentials field |
{- "facilitationCertificationEnabled": true,
- "facilitationCredentialEnabled": true,
- "certifications": [ ],
- "credentials": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates facilitation service - section 2 (experience).
From routes/coach/profile.js — calls coachProfileController.updateFacilitationServiceSec2
Backed by controller coachProfileController.updateFacilitationServiceSec2.
| facilitationExperience | number Facilitation experience field |
| highestClientLevel | number Highest client level field |
| facilitationProgramCount | number Facilitation program count field |
| isContentCreator | boolean Is content creator field |
| facilitationWorkEnabled | boolean Facilitation work enabled field |
| facilitationWork | Array of objects Facilitation work field |
| clientFacilitated | Array of objects Client facilitated field |
{- "facilitationExperience": 1,
- "highestClientLevel": 1,
- "facilitationProgramCount": 1,
- "isContentCreator": true,
- "facilitationWorkEnabled": true,
- "facilitationWork": [ ],
- "clientFacilitated": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates facilitation service - section 3 (delivery mode).
From routes/coach/profile.js — calls coachProfileController.updateFacilitationServiceSec3
Backed by controller coachProfileController.updateFacilitationServiceSec3.
| deliveryMode | Array of objects Delivery mode field |
| openToTravelOtherCity | boolean Open to travel other city field |
| openToTravelOverseas | boolean Open to travel overseas field |
{- "deliveryMode": [ ],
- "openToTravelOtherCity": true,
- "openToTravelOverseas": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates facilitation fee.
From routes/coach/profile.js — calls coachProfileController.updateFacilitationFeeInfo with actionType=Add
Backed by controller coachProfileController.updateFacilitationFeeInfo.
| facilitationFeeInfo | object Facilitation fee info field |
| facilitationDayType | string Facilitation day type field |
| facilitationModeType | string Facilitation mode type field |
{- "facilitationFeeInfo": { },
- "facilitationDayType": "sample facilitation day type",
- "facilitationModeType": "sample facilitation mode type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes facilitation fee.
From routes/coach/profile.js — calls coachProfileController.updateFacilitationFeeInfo with actionType=Remove
Backed by controller coachProfileController.updateFacilitationFeeInfo.
| facilitationFeeInfo | object Facilitation fee info field |
| facilitationDayType | string Facilitation day type field |
| facilitationModeType | string Facilitation mode type field |
{- "facilitationFeeInfo": { },
- "facilitationDayType": "sample facilitation day type",
- "facilitationModeType": "sample facilitation mode type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves assessment service data.
From routes/coach/profile.js — calls coachProfileController.assessmentService
Backed by controller coachProfileController.assessmentService.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates assessment service - section 1 (certifications).
From routes/coach/profile.js — calls coachProfileController.updateAssessmentServiceSec1
Backed by controller coachProfileController.updateAssessmentServiceSec1.
| assessmentCertificationEnabled | boolean Assessment certification enabled field |
| certifications | Array of objects Certifications field |
{- "assessmentCertificationEnabled": true,
- "certifications": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates assessment service - section 2 (experience).
From routes/coach/profile.js — calls coachProfileController.updateAssessmentServiceSec2
Backed by controller coachProfileController.updateAssessmentServiceSec2.
| assessmentExperience | number Assessment experience field |
| assessmentProgramCount | number Assessment program count field |
| isCertifiedAccessor | boolean Is certified accessor field |
| isDesigningAssessmentTool | boolean Is designing assessment tool field |
| assessmentProgramEnabled | boolean Assessment program enabled field |
| assessmentProgram | Array of objects Assessment program field |
{- "assessmentExperience": 1,
- "assessmentProgramCount": 1,
- "isCertifiedAccessor": true,
- "isDesigningAssessmentTool": true,
- "assessmentProgramEnabled": true,
- "assessmentProgram": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates assessment service - section 3 (delivery mode).
From routes/coach/profile.js — calls coachProfileController.updateAssessmentServiceSec3
Backed by controller coachProfileController.updateAssessmentServiceSec3.
| deliveryMode | Array of objects Delivery mode field |
| openToTravelOtherCity | boolean Open to travel other city field |
| openToTravelOverseas | boolean Open to travel overseas field |
{- "deliveryMode": [ ],
- "openToTravelOtherCity": true,
- "openToTravelOverseas": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates assessment fee.
From routes/coach/profile.js — calls coachProfileController.updateAssessmentFeeInfo with actionType=Add
Backed by controller coachProfileController.updateAssessmentFeeInfo.
| assessmentFeeInfo | object Assessment fee info field |
| assessmentType | string Assessment type field |
{- "assessmentFeeInfo": { },
- "assessmentType": "sample assessment type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes assessment fee.
From routes/coach/profile.js — calls coachProfileController.updateAssessmentFeeInfo with actionType=Remove
Backed by controller coachProfileController.updateAssessmentFeeInfo.
| assessmentFeeInfo | object Assessment fee info field |
| assessmentType | string Assessment type field |
{- "assessmentFeeInfo": { },
- "assessmentType": "sample assessment type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves profile header (branding).
From routes/coach/profile.js — calls coachProfileController.brandingHeader
Backed by controller coachProfileController.brandingHeader.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates profile header (branding).
From routes/coach/profile.js — calls coachProfileController.updateBrandingHeader
Backed by controller coachProfileController.updateBrandingHeader.
| header | number Header field |
| description | string Description field |
| aboutMe | string About me field |
| myBelief | string My belief field |
| keyAchievements | string Key achievements field |
{- "header": 1,
- "description": "sample description",
- "aboutMe": "sample about me",
- "myBelief": "sample my belief",
- "keyAchievements": "sample key achievements"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach 'my belief' branding text.
From routes/coach/profile.js — calls coachProfileController.brandingMybelief
Backed by controller coachProfileController.brandingMybelief.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coach 'my belief' branding text.
From routes/coach/profile.js — calls coachProfileController.updateBrandingMybelief
Backed by controller coachProfileController.updateBrandingMybelief.
| myBelief | string My belief field |
{- "myBelief": "sample my belief"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach global exposure countries.
From routes/coach/profile.js — calls coachProfileController.globalExposure
Backed by controller coachProfileController.globalExposure.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coach global exposure countries.
From routes/coach/profile.js — calls coachProfileController.updateGlobalExposure
Backed by controller coachProfileController.updateGlobalExposure.
| coachingCountries | Array of objects Coaching countries field |
| corporateExpCountries | Array of objects Corporate exp countries field |
{- "coachingCountries": [ ],
- "corporateExpCountries": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves profile completion progress info.
From routes/coach/profile.js — calls coachProfileController.getProfileProgressInfo
Backed by controller coachProfileController.getProfileProgressInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach's own public profile (internal view, authenticated).
From routes/coach/profile.js — calls coachProfileController.getPublicProfileData
Backed by controller coachProfileController.getPublicProfileData.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach public profile as learner sees (no auth required).
From routes/coach/profile.js — calls coachProfileController.getPublicProfileData (no verifyToken middleware)
Backed by controller coachProfileController.getPublicProfileData.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach public profile without login.
From routes/coach/profile.js — calls coachProfileController.fetchPublicProfileData (no verifyToken middleware)
Backed by controller coachProfileController.fetchPublicProfileData.
| coachId | number Coach's user ID |
| authId | string <uuid> External identity provider's user ID |
{- "coachId": 12345,
- "authId": "550e8400-e29b-41d4-a716-446655440000"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates profile summary.
From routes/coach/profile.js — calls coachProfileController.updateSummary
Backed by controller coachProfileController.updateSummary.
| profileSummary | string Profile summary field |
{- "profileSummary": "sample profile summary"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates industries worked list.
From routes/coach/profile.js — calls coachProfileController.updateIndustries
Backed by controller coachProfileController.updateIndustries.
| industriesWorked | Array of objects Industries worked field |
{- "industriesWorked": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates functions worked list.
From routes/coach/profile.js — calls coachProfileController.updateFunctions
Backed by controller coachProfileController.updateFunctions.
| functionsWorked | Array of objects Functions worked field |
{- "functionsWorked": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates certifications (deprecated).
From routes/coach/profile.js — calls coachProfileController.updateCertifications. Deprecated.
Backed by controller coachProfileController.updateCertifications..
| credentials | Array of objects Credentials field |
{- "credentials": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves internal coach - coaching service info.
From routes/coach/profile.js — calls coachProfileController.getCoachingServiceInfo
Backed by controller coachProfileController.getCoachingServiceInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates internal coach - coaching service info.
From routes/coach/profile.js — calls coachProfileController.updateCoachingServiceInfo
Backed by controller coachProfileController.updateCoachingServiceInfo.
| enableCoaching | boolean Enable coaching field |
| coachingSkills | Array of objects Coaching skills field |
| certifications | Array of objects Certifications field |
{- "enableCoaching": true,
- "coachingSkills": [ ],
- "certifications": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves internal coach - mentoring service info.
From routes/coach/profile.js — calls coachProfileController.getMentoringServiceInfo
Backed by controller coachProfileController.getMentoringServiceInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates internal coach - mentoring service info.
From routes/coach/profile.js — calls coachProfileController.updateMentoringServiceInfo
Backed by controller coachProfileController.updateMentoringServiceInfo.
| enableMentoring | boolean Enable mentoring field |
| mentoringSkills | Array of objects Mentoring skills field |
| certifications | Array of objects Certifications field |
{- "enableMentoring": true,
- "mentoringSkills": [ ],
- "certifications": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach's calendar connection status.
From routes/coach/profile.js — calls coachProfileController.getCalendarStatus with userRole=Coach
Backed by controller coachProfileController.getCalendarStatus.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a new session.
From routes/coach/session.js - calls coachSessionController.createSession with userRole=Coach
Backed by controller coachSessionController.createSession.
| coachId | number Coach's user ID |
| userId | number Internal user ID (foreign key) |
| engagementId | number Engagement ID |
| programId | number Program ID |
| sessionName | string Session name field |
| sessionDesc | string Session desc field |
| sessionType | string Session type field |
| startDateTime | string <date-time> Start date time field |
| endDateTime | string <date-time> End date time field |
| duration | number Duration field |
| timezone | string Timezone field |
| sessionMode | number Session mode field |
| vcToolType | string Vc tool type field |
| vcToolLink | string Vc tool link field |
| location | string Location field |
| comment | string Comment field |
{- "coachId": 12345,
- "userId": 12345,
- "engagementId": 12345,
- "programId": 12345,
- "sessionName": "sample session name",
- "sessionDesc": "sample session desc",
- "sessionType": "sample session type",
- "startDateTime": "2026-05-13T09:00:00.000Z",
- "endDateTime": "2026-05-13T09:00:00.000Z",
- "duration": 1,
- "timezone": "sample timezone",
- "sessionMode": 1,
- "vcToolType": "sample vc tool type",
- "vcToolLink": "sample vc tool link",
- "location": "sample location",
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates session name.
From routes/coach/session.js - calls coachSessionController.updateSessionName with userRole=Coach
Backed by controller coachSessionController.updateSessionName.
| sessionId | number Session ID |
| sessionName | string Session name field |
{- "sessionId": 12345,
- "sessionName": "sample session name"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits reschedule a session (one-on-one or group/workshop). From routes/coach/session.js - routes to coachSessionController.rescheduleSession or coachGroupSessionController.rescheduleGroupSession based on sessionType. No verifyToken middleware.
| sessionId | number Session ID |
| sessionType | string Session type field |
| startDateTime | string <date-time> Start date time field |
| endDateTime | string <date-time> End date time field |
| timezone | string Timezone field |
| comment | string Comment field |
| sessionName | string Session name field |
| sessionMode | number Session mode field |
| vcType | string Vc type field |
| meetingUrl | string <uri> Meeting url field |
| saveAsDefaultVcLink | boolean Save as default vc link field |
| location | string Location field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "startDateTime": "2026-05-13T09:00:00.000Z",
- "endDateTime": "2026-05-13T09:00:00.000Z",
- "timezone": "sample timezone",
- "comment": "sample comment",
- "sessionName": "sample session name",
- "sessionMode": 1,
- "vcType": "sample vc type",
- "saveAsDefaultVcLink": true,
- "location": "sample location"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits cancel a session (one-on-one or group/workshop). From routes/coach/session.js - routes to coachSessionController.cancelSession or coachGroupSessionController.cancelGroupSession based on sessionType. No verifyToken middleware.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
| userRole | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| comment | string Comment field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type",
- "userRole": "coach",
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves session meeting info.
From routes/coach/session.js - calls coachSessionController.GetSessionMeetingInfo. No verifyToken middleware.
Backed by controller coachSessionController.GetSessionMeetingInfo..
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits accept a session as coach (one-on-one or group/workshop). From routes/coach/session.js - routes to coachSessionController.coachAcceptSession or coachGroupSessionController.coachAcceptGroupSession based on sessionType. No verifyToken middleware.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves session feedback / reflection info for a user.
From routes/coach/session.js - calls coachSessionController.getUserFeedbackInfo with userRole=Coach
Backed by controller coachSessionController.getUserFeedbackInfo.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits view group session reflection (forces sessionType=Group).
From routes/coach/session.js - calls coachSessionController.getUserFeedbackInfo with sessionType=Group
Backed by controller coachSessionController.getUserFeedbackInfo.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
{- "userId": 12345,
- "sessionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits view workshop reflection (forces sessionType=Workshop).
From routes/coach/session.js - calls coachSessionController.getWorkshopFeedbackInfo
Backed by controller coachSessionController.getWorkshopFeedbackInfo.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
{- "userId": 12345,
- "sessionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits session reflection / feedback.
From routes/coach/session.js - calls coachSessionController.submitSessionRelection with userRole=Coach. No verifyToken middleware.
Backed by controller coachSessionController.submitSessionRelection.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
| openToFeedback | number Open to feedback field |
| willingnessToAct | number Willingness to act field |
| involvement | number Involvement field |
| knowledgeSharing | number Knowledge sharing field |
| areaOfChange | string Area of change field |
| potentialObstacles | string Potential obstacles field |
| supportNeeded | string Support needed field |
| feedback | string Feedback field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type",
- "openToFeedback": 1,
- "willingnessToAct": 1,
- "involvement": 1,
- "knowledgeSharing": 1,
- "areaOfChange": "sample area of change",
- "potentialObstacles": "sample potential obstacles",
- "supportNeeded": "sample support needed",
- "feedback": "sample feedback"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits group session reflection (same handler as submit_feedback).
From routes/coach/session.js - calls coachSessionController.submitSessionRelection. No verifyToken middleware.
Backed by controller coachSessionController.submitSessionRelection..
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
| openToFeedback | number Open to feedback field |
| willingnessToAct | number Willingness to act field |
| involvement | number Involvement field |
| knowledgeSharing | number Knowledge sharing field |
| areaOfChange | string Area of change field |
| potentialObstacles | string Potential obstacles field |
| supportNeeded | string Support needed field |
| feedback | string Feedback field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type",
- "openToFeedback": 1,
- "willingnessToAct": 1,
- "involvement": 1,
- "knowledgeSharing": 1,
- "areaOfChange": "sample area of change",
- "potentialObstacles": "sample potential obstacles",
- "supportNeeded": "sample support needed",
- "feedback": "sample feedback"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates session meeting info (VC link / type).
From routes/coach/session.js - calls coachSessionController.updateMeetingInfo. Note - controller method has non-standard signature; route passes (req, res).
Backed by controller coachSessionController.updateMeetingInfo..
| sessionId | number Session ID |
| sessionType | string Session type field |
| vcToolType | string Vc tool type field |
| vcToolLink | string Vc tool link field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "vcToolType": "sample vc tool type",
- "vcToolLink": "sample vc tool link"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark session as in-progress.
From routes/coach/session.js - calls coachSessionController.changeStatusAsInProgress with userRole=Coach
Backed by controller coachSessionController.changeStatusAsInProgress.
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark session as completed.
From routes/coach/session.js - calls coachSessionController.markSessionCompleted with userRole=Coach
Backed by controller coachSessionController.markSessionCompleted.
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user session calendar event id.
From routes/coach/session.js - calls coachSessionController.updateUserSessionCalendarEvent with userRole=Coach
Backed by controller coachSessionController.updateUserSessionCalendarEvent.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
| calType | string Cal type field |
| eventId | string <uuid> Event id (identifier) |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type",
- "calType": "sample cal type",
- "eventId": "550e8400-e29b-41d4-a716-446655440000"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user session calendar event id.
From routes/coach/session.js - calls coachSessionController.fetchUserSessionCalendarEvent with userRole=Coach
Backed by controller coachSessionController.fetchUserSessionCalendarEvent.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Invites a user to users to a session.
From routes/coach/session.js - calls coachSessionController.inviteSessionUsers
Backed by controller coachSessionController.inviteSessionUsers.
| sessionId | number Session ID |
| sessionType | string Session type field |
| invitedUsers | Array of objects Invited users field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "invitedUsers": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a new coaching tool.
From routes/coach/coaching_tool.js - calls coachingToolController.AddNewCoachingTool
Backed by controller coachingToolController.AddNewCoachingTool.
| toolId | number Coaching tool ID |
| toolCategory | string Tool category field |
| userLevel | number User level field |
| competencies | Array of objects Competencies field |
| isAITool | boolean Is aitool field |
| toolName | string Coaching tool name |
| toolDesc | string Tool desc field |
| toolStructure | object Tool structure field |
| isClonable | boolean Is clonable field |
| isPublic | boolean Is public field |
| isSharable | boolean Is sharable field |
{- "toolId": 12345,
- "toolCategory": "sample tool category",
- "userLevel": 1,
- "competencies": [ ],
- "isAITool": true,
- "toolName": "GROW model",
- "toolDesc": "sample tool desc",
- "toolStructure": { },
- "isClonable": true,
- "isPublic": true,
- "isSharable": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates a coaching tool (same handler as add_tool).
From routes/coach/coaching_tool.js - calls coachingToolController.AddNewCoachingTool
Backed by controller coachingToolController.AddNewCoachingTool.
| toolId | number Coaching tool ID |
| toolCategory | string Tool category field |
| userLevel | number User level field |
| competencies | Array of objects Competencies field |
| isAITool | boolean Is aitool field |
| toolName | string Coaching tool name |
| toolDesc | string Tool desc field |
| toolStructure | object Tool structure field |
| isClonable | boolean Is clonable field |
| isPublic | boolean Is public field |
| isSharable | boolean Is sharable field |
{- "toolId": 12345,
- "toolCategory": "sample tool category",
- "userLevel": 1,
- "competencies": [ ],
- "isAITool": true,
- "toolName": "GROW model",
- "toolDesc": "sample tool desc",
- "toolStructure": { },
- "isClonable": true,
- "isPublic": true,
- "isSharable": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coaching tool structure (questions).
From routes/coach/coaching_tool.js - calls coachingToolController.UpdateCoachingToolStructure
Backed by controller coachingToolController.UpdateCoachingToolStructure.
| toolId | number Coaching tool ID |
| toolStructure | object Tool structure field |
{- "toolId": 12345,
- "toolStructure": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coaching tool scoring logic.
From routes/coach/coaching_tool.js - calls coachingToolController.UpdateCoachingToolScoringLogic
Backed by controller coachingToolController.UpdateCoachingToolScoringLogic.
| toolId | number Coaching tool ID |
| scoringLogic | Array of objects Scoring logic field |
{- "toolId": 12345,
- "scoringLogic": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all coaching tools for the coach.
From routes/coach/coaching_tool.js - calls coachingToolController.GetAllCoachingTools
Backed by controller coachingToolController.GetAllCoachingTools.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coaching tool details.
From routes/coach/coaching_tool.js - calls coachingToolController.GetCoachingToolDetails
Backed by controller coachingToolController.GetCoachingToolDetails.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits clone a coaching tool.
From routes/coach/coaching_tool.js - calls coachingToolController.CloneCoachingTool
Backed by controller coachingToolController.CloneCoachingTool.
| toolId | number Coaching tool ID |
| toolName | string Coaching tool name |
| comment | string Comment field |
{- "toolId": 12345,
- "toolName": "GROW model",
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark a tool as favorite.
From routes/coach/coaching_tool.js - calls coachingToolController.markFavoriteTool
Backed by controller coachingToolController.markFavoriteTool.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits unmark a tool as favorite.
From routes/coach/coaching_tool.js - calls coachingToolController.unMarkFavoriteTool
Backed by controller coachingToolController.unMarkFavoriteTool.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all favorite tools.
From routes/coach/coaching_tool.js - calls coachingToolController.getAllFavoriteTools
Backed by controller coachingToolController.getAllFavoriteTools.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits publish a coaching tool.
From routes/coach/coaching_tool.js - calls coachingToolController.PublishCoachingTool
Backed by controller coachingToolController.PublishCoachingTool.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits unpublish a coaching tool.
From routes/coach/coaching_tool.js - calls coachingToolController.UpdateCoachingToolStatus with status=UnPublish
Backed by controller coachingToolController.UpdateCoachingToolStatus.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a coaching tool.
From routes/coach/coaching_tool.js - calls coachingToolController.UpdateCoachingToolStatus with status=Delete
Backed by controller coachingToolController.UpdateCoachingToolStatus.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves program-wise connected users.
From routes/coach/coaching_tool.js - calls coachingToolController.GetProgramWiseConnectedUsers
Backed by controller coachingToolController.GetProgramWiseConnectedUsers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users for sharing tools.
From routes/coach/coaching_tool.js - calls coachingToolController.GetConnectedUsers
Backed by controller coachingToolController.GetConnectedUsers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected groups for sharing tools.
From routes/coach/coaching_tool.js - calls coachingToolController.GetConnectedGroups
Backed by controller coachingToolController.GetConnectedGroups.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected programs for sharing tools.
From routes/coach/coaching_tool.js - calls coachingToolController.GetConnectedPrograms
Backed by controller coachingToolController.GetConnectedPrograms.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits bulk invite stakeholders via CSV upload.
From routes/coach/coaching_tool.js - calls coachingToolController.BulkInviteStakeholdersForLearners. Admin / GroupAdmin / Coach.
Backed by controller coachingToolController.BulkInviteStakeholdersForLearners..
| toolId | number Coaching tool ID |
| stakeholders | Array of objects Stakeholders field |
{- "toolId": 12345,
- "stakeholders": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits pre-validate CSV learner emails against onboarded users.
From routes/coach/coaching_tool.js - calls coachingToolController.ValidateLearnerEmails. Admin / GroupAdmin / Coach.
Backed by controller coachingToolController.ValidateLearnerEmails..
| toolId | number Coaching tool ID |
| learnerEmails | Array of strings Learner emails field |
{- "toolId": 12345,
- "learnerEmails": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coaching tool program name.
From routes/coach/coaching_tool.js - calls coachingToolController.GetCoachingToolProgramName
Backed by controller coachingToolController.GetCoachingToolProgramName.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Sends reminder to coachees to submit tool.
From routes/coach/coaching_tool.js - calls coachingToolController.SendReminderToCoacheeToSubmit
Backed by controller coachingToolController.SendReminderToCoacheeToSubmit.
| toolId | number Coaching tool ID |
| userId | Array of objects Internal user ID (foreign key) |
{- "toolId": 12345,
- "userId": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool instance details.
From routes/coach/coaching_tool.js - calls coachingToolController.GetToolInstanceDetails
Backed by controller coachingToolController.GetToolInstanceDetails.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits recall a shared tool.
From routes/coach/coaching_tool.js - calls coachingToolController.RecallTool
Backed by controller coachingToolController.RecallTool.
| toolId | number Coaching tool ID |
| userId | number Internal user ID (foreign key) |
{- "toolId": 12345,
- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits change due date of one or more shared tools.
From routes/coach/coaching_tool.js - calls coachingToolController.ChangeDueDateOfTool
Backed by controller coachingToolController.ChangeDueDateOfTool.
| toolIds | Array of objects Tool ids field |
| dueDate | string <date> Target completion date (ISO 8601) |
| forAllLearners | boolean For all learners field |
| forAllStakeholders | boolean For all stakeholders field |
{- "toolIds": [ ],
- "dueDate": "2026-05-13",
- "forAllLearners": true,
- "forAllStakeholders": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coaching tool report for a coachee.
From routes/coach/coaching_tool.js - calls coachingToolController.GetCoachingToolReport
Backed by controller coachingToolController.GetCoachingToolReport.
| toolId | number Coaching tool ID |
| userId | number Internal user ID (foreign key) |
{- "toolId": 12345,
- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves complete stakeholder tool report.
From routes/coach/coaching_tool.js - calls coachingToolController.GetStakeHolderToolReport
Backed by controller coachingToolController.GetStakeHolderToolReport.
| toolId | number Coaching tool ID |
| userId | number Internal user ID (foreign key) |
| requestedBy | number Requested by field |
{- "toolId": 12345,
- "userId": 12345,
- "requestedBy": 1
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves stakeholder tool report via token (no auth).
From routes/coach/coaching_tool.js - calls coachingToolController.GetStakeHolderToolReportWithToken. No verifyToken middleware.
Backed by controller coachingToolController.GetStakeHolderToolReportWithToken..
| toolId | number Coaching tool ID |
| userId | number Internal user ID (foreign key) |
| requestedBy | number Requested by field |
| token | string Auth or session token |
{- "toolId": 12345,
- "userId": 12345,
- "requestedBy": 1,
- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves stakeholder tool report by UUID.
From routes/coach/coaching_tool.js - calls coachingToolController.GetStakeHolderToolReportByUUID
Backed by controller coachingToolController.GetStakeHolderToolReportByUUID.
| accessKey | string Access key field |
{- "accessKey": "sample access key"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Generates a PDF report for a coaching tool.
From routes/coach/coaching_tool.js - calls coachingToolController.generatePdfReport
Backed by controller coachingToolController.generatePdfReport.
| toolId | number Coaching tool ID |
| userId | number Internal user ID (foreign key) |
| isEmailToSend | boolean Is email to send field |
| requestedBy | number Requested by field |
| emailToSend | boolean Email to send field |
{- "toolId": 12345,
- "userId": 12345,
- "isEmailToSend": true,
- "requestedBy": 1,
- "emailToSend": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool comparison report (across attempts / dates).
From routes/coach/coaching_tool.js - calls coachingToolController.GetToolComparisonReport
Backed by controller coachingToolController.GetToolComparisonReport.
| toolIds | Array of objects Tool ids field |
| userId | number Internal user ID (foreign key) |
{- "toolIds": [ ],
- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves comparison report via token (no auth).
From routes/coach/coaching_tool.js - calls coachingToolController.GetComparisionToolReportWithToken. No verifyToken middleware.
Backed by controller coachingToolController.GetComparisionToolReportWithToken..
| toolIds | Array of objects Tool ids field |
| userId | number Internal user ID (foreign key) |
| token | string Auth or session token |
{- "toolIds": [ ],
- "userId": 12345,
- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Generates comparison PDF report.
From routes/coach/coaching_tool.js - calls coachingToolController.generateComparisonReportPdf
Backed by controller coachingToolController.generateComparisonReportPdf.
| toolIds | Array of objects Tool ids field |
| userId | number Internal user ID (foreign key) |
| requestedBy | number Requested by field |
| isEmailToSend | boolean Is email to send field |
{- "toolIds": [ ],
- "userId": 12345,
- "requestedBy": 1,
- "isEmailToSend": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool response summary CSV.
From routes/coach/coaching_tool.js - calls coachingToolController.getToolResponseSummaryCsv
Backed by controller coachingToolController.getToolResponseSummaryCsv.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool rating summary CSV.
From routes/coach/coaching_tool.js - calls coachingToolController.getToolRatingSummaryCsv
Backed by controller coachingToolController.getToolRatingSummaryCsv.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates tool AI summary.
From routes/coach/coaching_tool.js - calls coachingToolController.UpdateToolAISummary
Backed by controller coachingToolController.UpdateToolAISummary.
| toolId | number Coaching tool ID |
| aiSummary | object Ai summary field |
{- "toolId": 12345,
- "aiSummary": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool AI summary.
From routes/coach/coaching_tool.js - calls coachingToolController.GetToolAISummary
Backed by controller coachingToolController.GetToolAISummary.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Authenticates user.
From routes/common/auth.js — calls commonAuthController.userLogin
Backed by controller commonAuthController.userLogin.
| authId | string <uuid> External identity provider's user ID |
| userRole | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
| provider | string External identity provider name (e.g. firebase, google, microsoft) |
| channelId | string <uuid> Notification channel identifier |
| ipAddress | string Caller's IP address |
| geoInfo | object Geographic info derived from IP |
{- "authId": "550e8400-e29b-41d4-a716-446655440000",
- "userRole": "coach",
- "provider": "firebase",
- "channelId": "550e8400-e29b-41d4-a716-446655440000",
- "ipAddress": "sample ip address",
- "geoInfo": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates user account.
From routes/common/auth.js — calls commonAuthController.createUserAccount
Backed by controller commonAuthController.createUserAccount.
| id | number Generic identifier |
| status | string Status code (see business rules) |
| authId | string <uuid> External identity provider's user ID |
{- "id": 12345,
- "status": "sample status",
- "authId": "550e8400-e29b-41d4-a716-446655440000"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves outlook OAuth token.
From routes/common/auth.js — calls commonAuthController.getOutLookToken (delegates to outlook.getToken)
Backed by controller commonAuthController.getOutLookToken.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits refresh Outlook OAuth token.
From routes/common/auth.js — calls commonAuthController.getOutLookRefreshToken (delegates to outlook.refreshToken)
Backed by controller commonAuthController.getOutLookRefreshToken.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves load onboarding info for logged-in user.
From routes/common/onboarding.js — calls commonOnBoardingController.load_onboarding_info
Backed by controller commonOnBoardingController.load_onboarding_info.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user personal info (onboarding).
From routes/common/onboarding.js — calls commonSettingsController.getPersonalInfo
Backed by controller commonSettingsController.getPersonalInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user personal info (onboarding).
From routes/common/onboarding.js — calls commonSettingsController.updatePersonalInfo
Backed by controller commonSettingsController.updatePersonalInfo.
| fullName | string User's full name |
| salutation | string Salutation field |
| mobile | string E.164 mobile number |
| zipcode | string Zipcode field |
| city | string City field |
| country | string Country field |
| countryCode | string Country code field |
| timezone | string Timezone field |
| language | Array of arrays Language field |
| enableWhatsapp | boolean Enable whatsapp field |
{- "fullName": "John Doe",
- "salutation": "sample salutation",
- "mobile": "+919876543210",
- "zipcode": "sample zipcode",
- "city": "sample city",
- "country": "sample country",
- "countryCode": "sample country code",
- "timezone": "sample timezone",
- "language": [ ],
- "enableWhatsapp": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user corporate info (onboarding).
From routes/common/onboarding.js — calls coachProfileSettingsController.getUserCorporateInfo
Backed by controller coachProfileSettingsController.getUserCorporateInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user corporate info (onboarding).
From routes/common/onboarding.js — calls coachProfileSettingsController.updateUserCorporateInfo
Backed by controller coachProfileSettingsController.updateUserCorporateInfo.
| corporateExp | number Corporate exp field |
| corporateExpYear | number Corporate exp year field |
| corporateExpMonth | number Corporate exp month field |
| industries | Array of arrays Industries field |
| functions | Array of arrays Functions field |
| currentRole | number Current role field |
| designation | string Designation field |
| organizationsWorked | Array of arrays Organizations worked field |
{- "corporateExp": 1,
- "corporateExpYear": 1,
- "corporateExpMonth": 1,
- "industries": [ ],
- "functions": [ ],
- "currentRole": 1,
- "designation": "sample designation",
- "organizationsWorked": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user coaching info (onboarding).
From routes/common/onboarding.js — calls commonOnBoardingController.coaching_info
Backed by controller commonOnBoardingController.coaching_info.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user coaching info (onboarding).
From routes/common/onboarding.js — calls commonOnBoardingController.update_coaching_info
Backed by controller commonOnBoardingController.update_coaching_info.
| coachingExp | number Coaching exp field |
| coachingExpYear | number Coaching exp year field |
| coachingExpMonth | number Coaching exp month field |
| coachingSkills | Array of arrays Coaching skills field |
| levelsCoached | number Levels coached field |
| isFacilitationEnabled | boolean Is facilitation enabled field |
| isAssessmentEnabled | boolean Is assessment enabled field |
{- "coachingExp": 1,
- "coachingExpYear": 1,
- "coachingExpMonth": 1,
- "coachingSkills": [ ],
- "levelsCoached": 1,
- "isFacilitationEnabled": true,
- "isAssessmentEnabled": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user availability info (onboarding).
From routes/common/onboarding.js — calls commonSettingsController.availabilityInfo
Backed by controller commonSettingsController.availabilityInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user availability info (onboarding).
From routes/common/onboarding.js — calls commonSettingsController.updateAvailabilityInfo
Backed by controller commonSettingsController.updateAvailabilityInfo.
| dayTimeRange | Array of arrays Day time range field |
{- "dayTimeRange": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves calendar connected info (onboarding).
From routes/common/onboarding.js — calls commonSettingsController.calendarConnectedInfo
Backed by controller commonSettingsController.calendarConnectedInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates calendar connectivity (onboarding).
From routes/common/onboarding.js — calls commonSettingsController.updateCalendarConnectivity
Backed by controller commonSettingsController.updateCalendarConnectivity.
| calendarStatus | boolean Calendar status field |
| calendarType | string Calendar type field |
{- "calendarStatus": true,
- "calendarType": "sample calendar type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user corporate experience (coachee onboarding).
From routes/common/onboarding.js — calls commonOnBoardingController.user_experience
Backed by controller commonOnBoardingController.user_experience.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user corporate experience (coachee onboarding).
From routes/common/onboarding.js — calls commonOnBoardingController.update_user_experience
Backed by controller commonOnBoardingController.update_user_experience.
| corporateExp | number Corporate exp field |
| corporateExpYear | number Corporate exp year field |
| corporateExpMonth | number Corporate exp month field |
| designation | string Designation field |
| industries | Array of arrays Industries field |
| functions | Array of arrays Functions field |
| currentRole | number Current role field |
{- "corporateExp": 1,
- "corporateExpYear": 1,
- "corporateExpMonth": 1,
- "designation": "sample designation",
- "industries": [ ],
- "functions": [ ],
- "currentRole": 1
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves internal coach service info (onboarding).
From routes/common/onboarding.js — calls commonOnBoardingController.service_info
Backed by controller commonOnBoardingController.service_info.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates internal coach service info (onboarding).
From routes/common/onboarding.js — calls commonOnBoardingController.update_service_info
Backed by controller commonOnBoardingController.update_service_info.
| coachingSkills | Array of arrays Coaching skills field |
| mentoringSkills | Array of arrays Mentoring skills field |
| facilitation | object Facilitation field |
{- "coachingSkills": [ ],
- "mentoringSkills": [ ],
- "facilitation": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user profile config.
From routes/common/settings.js — calls commonSettingsController.getUserProfileConfig
Backed by controller commonSettingsController.getUserProfileConfig.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach services config.
From routes/common/settings.js — calls commonSettingsController.getCoachServicesConfig
Backed by controller commonSettingsController.getCoachServicesConfig.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates coaching service config.
From routes/common/settings.js — calls commonSettingsController.updateCoachServicesConfig
Backed by controller commonSettingsController.updateCoachServicesConfig.
| serviceType | string Service type field |
| serviceStatus | boolean Service status field |
{- "serviceType": "sample service type",
- "serviceStatus": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits enable coaching service (alias for update_coaching_service).
From routes/common/settings.js — calls commonSettingsController.updateCoachServicesConfig (duplicate route registered twice in source)
Backed by controller commonSettingsController.updateCoachServicesConfig.
| serviceType | string Service type field |
| serviceStatus | boolean Service status field |
| enableCoaching | boolean Enable coaching field |
{- "serviceType": "sample service type",
- "serviceStatus": true,
- "enableCoaching": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user personal info.
From routes/common/settings.js — calls commonSettingsController.getPersonalInfo
Backed by controller commonSettingsController.getPersonalInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user personal info.
From routes/common/settings.js — calls commonSettingsController.updatePersonalInfo
Backed by controller commonSettingsController.updatePersonalInfo.
| fullName | string User's full name |
| salutation | string Salutation field |
| mobile | string E.164 mobile number |
| zipcode | string Zipcode field |
| city | string City field |
| country | string Country field |
| countryCode | string Country code field |
| timezone | string Timezone field |
| language | Array of arrays Language field |
| enableWhatsapp | boolean Enable whatsapp field |
{- "fullName": "John Doe",
- "salutation": "sample salutation",
- "mobile": "+919876543210",
- "zipcode": "sample zipcode",
- "city": "sample city",
- "country": "sample country",
- "countryCode": "sample country code",
- "timezone": "sample timezone",
- "language": [ ],
- "enableWhatsapp": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits change user password.
From routes/common/settings.js — calls commonSettingsController.changePassword
Backed by controller commonSettingsController.changePassword.
| password | string User password (plaintext at API boundary; hashed server-side) |
{- "password": "Pa$$w0rd123"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits deactivate user account.
From routes/common/settings.js — calls commonSettingsController.deactivateAccount
Backed by controller commonSettingsController.deactivateAccount.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes user account.
From routes/common/settings.js — calls commonSettingsController.deleteAccount
Backed by controller commonSettingsController.deleteAccount.
| password | string User password (plaintext at API boundary; hashed server-side) |
{- "password": "Pa$$w0rd123"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves default meeting link.
From routes/common/settings.js — calls commonSettingsController.getDefaultMeetingLink
Backed by controller commonSettingsController.getDefaultMeetingLink.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates default meeting link.
From routes/common/settings.js — calls commonSettingsController.updateDefaultMeetingLink
Backed by controller commonSettingsController.updateDefaultMeetingLink.
| vcType | string Vc type field |
| meetingLink | string Meeting link field |
| isDefault | boolean Is default field |
{- "vcType": "sample vc type",
- "meetingLink": "sample meeting link",
- "isDefault": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves notification config.
From routes/common/settings.js — calls commonSettingsController.getNotificationConfig
Backed by controller commonSettingsController.getNotificationConfig.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates notification config.
From routes/common/settings.js — calls commonSettingsController.updateNotificationConfig
Backed by controller commonSettingsController.updateNotificationConfig.
| notificationType | string Notification type field |
| value | boolean Value field |
| channel | string Channel field |
{- "notificationType": "sample notification type",
- "value": true,
- "channel": "sample channel"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user availability info.
From routes/common/settings.js — calls commonSettingsController.availabilityInfo
Backed by controller commonSettingsController.availabilityInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user availability info.
From routes/common/settings.js — calls commonSettingsController.updateAvailabilityInfo
Backed by controller commonSettingsController.updateAvailabilityInfo.
| dayTimeRange | Array of arrays Day time range field |
{- "dayTimeRange": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user holiday dates.
From routes/common/settings.js — calls commonSettingsController.getHolidayDates
Backed by controller commonSettingsController.getHolidayDates.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves calendar connected info.
From routes/common/settings.js — calls commonSettingsController.calendarConnectedInfo
Backed by controller commonSettingsController.calendarConnectedInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates calendar connectivity.
From routes/common/settings.js — calls commonSettingsController.updateCalendarConnectivity
Backed by controller commonSettingsController.updateCalendarConnectivity.
| calendarStatus | boolean Calendar status field |
| calendarType | string Calendar type field |
{- "calendarStatus": true,
- "calendarType": "sample calendar type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits upload image (multipart). From routes/common/uploads.js — uses imageUploader.array("file", 1)
| file | string <binary> File field |
{- "result": "SUCCESS",
- "fileName": { }
}Submits upload logo (multipart). From routes/common/uploads.js — uses logoUploader.array("file", 1)
| file | string <binary> File field |
{- "result": "SUCCESS",
- "fileName": { }
}Submits upload file (multipart). From routes/common/uploads.js — uses fileUploader.single("file")
| file | string <binary> File field |
{- "result": "SUCCESS",
- "fileName": "sample file name"
}Submits upload notes file (multipart). From routes/common/uploads.js — uses noteFileUploader.single("file")
| file | string <binary> File field |
{- "result": "SUCCESS",
- "fileName": "sample file name"
}Submits upload credential file (multipart). From routes/common/uploads.js — uses fileUploader.array("file", 1)
| file | string <binary> File field |
{- "result": "SUCCESS",
- "fileName": { }
}Submits upload tool file (multipart). From routes/common/uploads.js — uses fileUploader.array("file", 1)
| file | string <binary> File field |
{- "result": "SUCCESS",
- "fileName": { }
}Retrieves load brand configs for logged-in user.
From routes/common/userRequest.js — calls commonUserRequestController.loadBrandConfigs
Backed by controller commonUserRequestController.loadBrandConfigs.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits switch user role.
From routes/common/userRequest.js — calls commonUserRequestController.switchRole
Backed by controller commonUserRequestController.switchRole.
| role | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
{- "role": "coach"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user profile timezone.
From routes/common/userRequest.js — calls commonUserRequestController.getUserTimezone
Backed by controller commonUserRequestController.getUserTimezone.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates user profile timezone.
From routes/common/userRequest.js — calls commonUserRequestController.updateUserTimezone
Backed by controller commonUserRequestController.updateUserTimezone.
| timezone | string Timezone field |
{- "timezone": "sample timezone"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves onboarding info for user.
From routes/common/userRequest.js — calls commonUserRequestController.onboardingInfo
Backed by controller commonUserRequestController.onboardingInfo.
| userRole | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
{- "userRole": "coach"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits dismiss onboarding for logged-in user.
From routes/common/userRequest.js — calls commonUserRequestController.dismissOnboarding
Backed by controller commonUserRequestController.dismissOnboarding.
| userRole | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
{- "userRole": "coach"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tour info for user.
From routes/common/userRequest.js — calls commonUserRequestController.getUserTourInfo
Backed by controller commonUserRequestController.getUserTourInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark tour as finished.
From routes/common/userRequest.js — calls commonUserRequestController.updateUserTourInfo
Backed by controller commonUserRequestController.updateUserTourInfo.
| tourType | string Tour type field |
| markFinished | boolean Mark finished field |
{- "tourType": "sample tour type",
- "markFinished": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all active notifications for user.
From routes/common/userRequest.js — calls commonUserRequestController.getUserNotifications
Backed by controller commonUserRequestController.getUserNotifications.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark a notification as read.
From routes/common/userRequest.js — calls commonUserRequestController.updateNotification (action=mark_read_notification)
Backed by controller commonUserRequestController.updateNotification.
| notificationId | number Notification id (identifier) |
{- "notificationId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark all notifications as read.
From routes/common/userRequest.js — calls commonUserRequestController.updateNotification (action=mark_read_all)
Backed by controller commonUserRequestController.updateNotification.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark a notification as unread.
From routes/common/userRequest.js — calls commonUserRequestController.updateNotification (action=mark_unread_notification)
Backed by controller commonUserRequestController.updateNotification.
| notificationId | number Notification id (identifier) |
{- "notificationId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark all notifications as unread.
From routes/common/userRequest.js — calls commonUserRequestController.updateNotification (action=mark_unread_all)
Backed by controller commonUserRequestController.updateNotification.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a notification (mark complete).
From routes/common/userRequest.js — calls commonUserRequestController.updateNotification (action=mark_complete)
Backed by controller commonUserRequestController.updateNotification.
| notificationId | number Notification id (identifier) |
{- "notificationId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes all notifications (mark complete all).
From routes/common/userRequest.js — calls commonUserRequestController.updateNotification (action=mark_complete_all)
Backed by controller commonUserRequestController.updateNotification.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits perform session action from email link.
From routes/common/userRequest.js — calls commonUserRequestController.performEmailAction
Backed by controller commonUserRequestController.performEmailAction.
| sessionInfo | string Session info field |
{- "sessionInfo": "sample session info"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits join meeting from email link.
From routes/common/userRequest.js — calls commonUserRequestController.joinMeeting
Backed by controller commonUserRequestController.joinMeeting.
| sessionInfo | string Session info field |
{- "sessionInfo": "sample session info"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves feedback form data from email link.
From routes/common/userRequest.js — calls commonUserRequestController.fetchFeedbackFormData
Backed by controller commonUserRequestController.fetchFeedbackFormData.
| sessionInfo | string Session info field |
{- "sessionInfo": "sample session info"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user actions.
From routes/learner/actions.js - calls coachActionController.getUserActions (userRole=Coachee)
Backed by controller coachActionController.getUserActions.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
{- "userId": 12345,
- "coachId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all actions for the learner.
From routes/learner/actions.js - calls coachActionController.getAllActions (userRole=Coachee)
Backed by controller coachActionController.getAllActions.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates an action.
From routes/learner/actions.js - calls coachActionController.addAction (userRole=Coachee)
Backed by controller coachActionController.addAction.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
| actionId | number Action ID |
| actionName | string Action name field |
| dueDate | string <date> Target completion date (ISO 8601) |
| progress | number Progress percentage (0-100) |
| description | string Description field |
| goalId | number Goal ID |
| isShared | boolean Is shared field |
| competencies | Array of objects Competencies field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "userId": 12345,
- "coachId": 12345,
- "actionId": 12345,
- "actionName": "sample action name",
- "dueDate": "2026-05-13",
- "progress": 50,
- "description": "sample description",
- "goalId": 12345,
- "isShared": true,
- "competencies": [ ],
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates an action.
From routes/learner/actions.js - calls coachActionController.updateAction
Backed by controller coachActionController.updateAction.
| actionId | number Action ID |
| actionName | string Action name field |
| dueDate | string <date> Target completion date (ISO 8601) |
| progress | number Progress percentage (0-100) |
| description | string Description field |
{- "actionId": 12345,
- "actionName": "sample action name",
- "dueDate": "2026-05-13",
- "progress": 50,
- "description": "sample description"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates action competencies.
From routes/learner/actions.js - calls coachActionController.updateActionCompetencies
Backed by controller coachActionController.updateActionCompetencies.
| actionId | number Action ID |
| competencies | Array of objects Competencies field |
{- "actionId": 12345,
- "competencies": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves action details.
From routes/learner/actions.js - calls coachActionController.getActionDetails
Backed by controller coachActionController.getActionDetails.
| actionId | number Action ID |
{- "actionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes an action.
From routes/learner/actions.js - calls coachActionController.DeleteAction
Backed by controller coachActionController.DeleteAction.
| actionId | number Action ID |
{- "actionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates comment to an action.
From routes/learner/actions.js - calls coachActionController.AddComment
Backed by controller coachActionController.AddComment.
| actionId | number Action ID |
| sendToAll | boolean Send to all field |
| comment | string Comment field |
{- "actionId": 12345,
- "sendToAll": true,
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark action as completed.
From routes/learner/actions.js - calls coachActionController.MarkActionCompleted
Backed by controller coachActionController.MarkActionCompleted.
| actionId | number Action ID |
{- "actionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a subtask to an action.
From routes/learner/actions.js - calls coachActionController.CreateActionSubtask
Backed by controller coachActionController.CreateActionSubtask.
| actionId | number Action ID |
| taskName | string Task name field |
| taskDesc | string Task desc field |
| actionTaskId | number Action task id (identifier) |
{- "actionId": 12345,
- "taskName": "sample task name",
- "taskDesc": "sample task desc",
- "actionTaskId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark subtask as completed.
From routes/learner/actions.js - calls coachActionController.MarkTaskCompleted
Backed by controller coachActionController.MarkTaskCompleted.
| actionTaskId | number Action task id (identifier) |
{- "actionTaskId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a subtask.
From routes/learner/actions.js - calls coachActionController.DeleteTask
Backed by controller coachActionController.DeleteTask.
| actionTaskId | number Action task id (identifier) |
{- "actionTaskId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Uploads a resource to an action.
From routes/learner/actions.js - calls coachActionController.UploadResource
Backed by controller coachActionController.UploadResource.
| actionId | number Action ID |
| resourceName | string Resource name field |
| fileName | string File name field |
| filePath | string File path field |
| fileSize | number File size field |
{- "actionId": 12345,
- "resourceName": "sample resource name",
- "fileName": "sample file name",
- "filePath": "sample file path",
- "fileSize": 1
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes an action resource.
From routes/learner/actions.js - calls coachActionController.DeleteResource
Backed by controller coachActionController.DeleteResource.
| resourceId | number Resource id (identifier) |
{- "resourceId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a link to an action.
From routes/learner/actions.js - calls coachActionController.UploadActionLink
Backed by controller coachActionController.UploadActionLink.
| actionId | number Action ID |
| linkName | string Link name field |
| actionLink | string Action link field |
| actionLinkId | number Action link id (identifier) |
{- "actionId": 12345,
- "linkName": "sample link name",
- "actionLink": "sample action link",
- "actionLinkId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes an action link.
From routes/learner/actions.js - calls coachActionController.DeleteActionLink
Backed by controller coachActionController.DeleteActionLink.
| actionLinkId | number Action link id (identifier) |
{- "actionLinkId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves group engagements info.
From routes/learner/actions.js - calls coachActionController.GetGroupEngagementsInfo
Backed by controller coachActionController.GetGroupEngagementsInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates follower to an action (not yet used).
From routes/learner/actions.js - calls coachActionController.AddFollowerToAction
Backed by controller coachActionController.AddFollowerToAction.
| actionId | number Action ID |
| followerName | string Follower name field |
| followerEmail | string <email> Follower email field |
{- "actionId": 12345,
- "followerName": "sample follower name",
- "followerEmail": "user@example.com"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes follower from an action (not yet used).
From routes/learner/actions.js - calls coachActionController.DeleteFollowerFromAction
Backed by controller coachActionController.DeleteFollowerFromAction.
| actionId | number Action ID |
| followerId | number Follower id (identifier) |
{- "actionId": 12345,
- "followerId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits inform coach for action (not yet used).
From routes/learner/actions.js - calls coachActionController.UpdateCoacheeForAction
Backed by controller coachActionController.UpdateCoacheeForAction.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user engagement program info (not yet used).
From routes/learner/actions.js - calls coachActionController.GetUserEngagementProgramInfo
Backed by controller coachActionController.GetUserEngagementProgramInfo.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves group engagement program info (not yet used).
From routes/learner/actions.js - calls coachActionController.GetGroupEngagementProgramInfo
Backed by controller coachActionController.GetGroupEngagementProgramInfo.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates stakeholder (not yet used).
From routes/learner/actions.js - calls coachActionController.AddStakeHolder
Backed by controller coachActionController.AddStakeHolder.
| userDetails | string User details field |
{- "userDetails": "sample user details"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves stakeholder info (not yet used).
From routes/learner/actions.js - calls coachActionController.GetStakeHolderInfo
Backed by controller coachActionController.GetStakeHolderInfo.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves group actions (not yet used).
From routes/learner/actions.js - calls coachActionController.GetGroupActions
Backed by controller coachActionController.GetGroupActions.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits action feedback.
From routes/learner/actions.js - calls coachActionController.submitActionFeedback (userRole=Coachee)
Backed by controller coachActionController.submitActionFeedback.
| actionId | number Action ID |
| rating | number Rating field |
| objectivity | number Objectivity field |
| efficiency | number Efficiency field |
| quality | number Quality field |
| accuracy | number Accuracy field |
| feedback | string Feedback field |
{- "actionId": 12345,
- "rating": 1,
- "objectivity": 1,
- "efficiency": 1,
- "quality": 1,
- "accuracy": 1,
- "feedback": "sample feedback"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a goal.
From routes/learner/actions.js - calls coachActionController.AddUpdateGoal
Backed by controller coachActionController.AddUpdateGoal.
| userId | number Internal user ID (foreign key) |
| goalId | number Goal ID |
| programId | number Program ID |
| goalName | string Goal name field |
| description | string Description field |
| comment | string Comment field |
| isShared | boolean Is shared field |
| dueDate | string <date> Target completion date (ISO 8601) |
| progress | number Progress percentage (0-100) |
{- "userId": 12345,
- "goalId": 12345,
- "programId": 12345,
- "goalName": "sample goal name",
- "description": "sample description",
- "comment": "sample comment",
- "isShared": true,
- "dueDate": "2026-05-13",
- "progress": 50
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates a goal.
From routes/learner/actions.js - calls coachActionController.AddUpdateGoal
Backed by controller coachActionController.AddUpdateGoal.
| userId | number Internal user ID (foreign key) |
| goalId | number Goal ID |
| programId | number Program ID |
| goalName | string Goal name field |
| description | string Description field |
| comment | string Comment field |
| isShared | boolean Is shared field |
| dueDate | string <date> Target completion date (ISO 8601) |
| progress | number Progress percentage (0-100) |
{- "userId": 12345,
- "goalId": 12345,
- "programId": 12345,
- "goalName": "sample goal name",
- "description": "sample description",
- "comment": "sample comment",
- "isShared": true,
- "dueDate": "2026-05-13",
- "progress": 50
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates goal progress.
From routes/learner/actions.js - calls coachActionController.UpdateGoalProgress
Backed by controller coachActionController.UpdateGoalProgress.
| goalId | number Goal ID |
| progress | number Progress percentage (0-100) |
{- "goalId": 12345,
- "progress": 50
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates comment to a goal (isShared forced to true).
From routes/learner/actions.js - calls coachActionController.AddGoalComment
Backed by controller coachActionController.AddGoalComment.
| goalId | number Goal ID |
| comment | string Comment field |
{- "goalId": 12345,
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a goal.
From routes/learner/actions.js - calls coachActionController.RemoveGoal
Backed by controller coachActionController.RemoveGoal.
| goalId | number Goal ID |
{- "goalId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves learner programs.
From routes/learner/connections/activities/activities.js - calls learnerActivitiesController.getPrograms
Backed by controller learnerActivitiesController.getPrograms.
| search | string |
{- "success": true,
- "data": [ ]
}Retrieves engagements with actions for a program.
From routes/learner/connections/activities/activities.js - calls learnerActivitiesController.getEngagementsWithActionsByProgram
Backed by controller learnerActivitiesController.getEngagementsWithActionsByProgram.
| programId required | string |
| status | string Enum: "In Progress" "Completed" "Overdue" |
| search | string |
| sortBy | string Enum: "dueDate" "createdAt" "updatedAt" |
| sortOrder | string Enum: "asc" "desc" |
{- "success": true,
- "data": [ ]
}Retrieves action details.
From routes/learner/connections/activities/activities.js - calls learnerActivitiesController.getActionDetails
Backed by controller learnerActivitiesController.getActionDetails.
| actionId required | string |
{- "success": true,
- "data": { }
}Updates task status (complete/incomplete).
From routes/learner/connections/activities/activities.js - calls learnerActivitiesController.updateTaskStatus
Backed by controller learnerActivitiesController.updateTaskStatus.
| actionId required | string |
| taskId required | string |
| action | string Enum: "complete" "incomplete" Action field |
{- "action": "sample action"
}{- "success": true,
- "data": { }
}Updates action progress.
From routes/learner/connections/activities/activities.js - calls learnerActivitiesController.updateActionProgress
Backed by controller learnerActivitiesController.updateActionProgress.
| actionId required | string |
| progress | number [ 0 .. 100 ] Progress percentage (0-100) |
{- "progress": 50
}{- "success": true,
- "data": { }
}Submits action with files and/or links.
From routes/learner/connections/activities/activities.js - multipart/form-data upload, calls learnerActivitiesController.submitAction
Backed by controller learnerActivitiesController.submitAction.
| actionId required | string |
| files[] | Array of strings <binary> [ items <binary > ] Files[] field |
| links | string JSON array of objects with title and url fields |
| comment | string Comment field |
| folder | string Folder field |
{- "success": true,
- "data": { }
}Removes an action submission (file or link).
From routes/learner/connections/activities/activities.js - calls learnerActivitiesController.removeSubmission
Backed by controller learnerActivitiesController.removeSubmission.
| actionId required | string |
| type required | string Enum: "file" "link" |
| submissionId required | string |
{- "success": true,
- "data": { }
}Sends chat message on an action.
From routes/learner/connections/activities/activities.js - calls learnerActivitiesController.sendChatMessage
Backed by controller learnerActivitiesController.sendChatMessage.
| actionId required | string |
| message | string Human-readable status message |
{- "message": "Operation completed"
}{- "success": true,
- "data": { }
}Retrieves connected coaches for the learner (external app friendly).
From routes/learner/connection.js - calls learnerConnectionController.getConnectedCoaches
Backed by controller learnerConnectionController.getConnectedCoaches.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users (GET variant, legacy).
From routes/learner/connection.js - calls coachConnectionController.getConnectedUsers (userRole=Coachee). TODO remove after UI change.
Backed by controller coachConnectionController.getConnectedUsers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users.
From routes/learner/connection.js - calls coachConnectionController.getConnectedUsers (userRole=Coachee)
Backed by controller coachConnectionController.getConnectedUsers.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user details for a connected user.
From routes/learner/connection.js - calls coachConnectionController.getUserDetails (userRole=Coachee)
Backed by controller coachConnectionController.getUserDetails.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves upcoming sessions for a connected user.
From routes/learner/connection.js - calls coachConnectionController.getUserUpcomingSessions (userRole=Coachee)
Backed by controller coachConnectionController.getUserUpcomingSessions.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves pending activities for a connected user.
From routes/learner/connection.js - calls coachConnectionController.getUserPendingActivities (userRole=Coachee)
Backed by controller coachConnectionController.getUserPendingActivities.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves sessions for a connected user.
From routes/learner/connection.js - calls coachConnectionController.getUserSessions (userRole=Coachee)
Backed by controller coachConnectionController.getUserSessions.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves all sessions for the learner.
From routes/learner/connection.js - calls coachConnectionController.getAllSessions (userRole=Coachee)
Backed by controller coachConnectionController.getAllSessions.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user goals for a connection.
From routes/learner/connection.js - calls coachConnectionController.getUserGoals (userRole=Coachee)
Backed by controller coachConnectionController.getUserGoals.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
{- "userId": 12345,
- "coachId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves comments on a goal.
From routes/learner/connection.js - calls coachConnectionController.getGoalComments
Backed by controller coachConnectionController.getGoalComments.
| goalId | number Goal ID |
{- "goalId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves matching growth areas.
From routes/learner/coach-search.js - calls coachSearchController.getMatchingGrowthAreas
Backed by controller coachSearchController.getMatchingGrowthAreas.
| statements | Array of strings Statements field |
{- "statements": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool-recommended coaches.
From routes/learner/coach-search.js - calls coachSearchController.getToolRecommendedCoaches
Backed by controller coachSearchController.getToolRecommendedCoaches.
| toolId | number Coaching tool ID |
| programId | number Program ID |
| corporateId | number Corporate (account) ID |
| userLevel | number User level field |
{- "toolId": 12345,
- "programId": 12345,
- "corporateId": 12345,
- "userLevel": 1
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves profile-recommended coaches.
From routes/learner/coach-search.js - calls coachSearchController.getProfileRecommendedCoaches
Backed by controller coachSearchController.getProfileRecommendedCoaches.
| programId | number Program ID |
| userLevel | number User level field |
| corporateId | number Corporate (account) ID |
{- "programId": 12345,
- "userLevel": 1,
- "corporateId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves recommended (searched) coaches.
From routes/learner/coach-search.js - calls coachSearchController.getSearchedCoaches
Backed by controller coachSearchController.getSearchedCoaches.
| programId | number Program ID |
| behaviouralSkills | Array of objects Behavioural skills field |
| technicalSkills | Array of objects Technical skills field |
| functionalSkills | Array of objects Functional skills field |
| userLevel | number User level field |
| corporateId | number Corporate (account) ID |
| statements | Array of strings Statements field |
{- "programId": 12345,
- "behaviouralSkills": [ ],
- "technicalSkills": [ ],
- "functionalSkills": [ ],
- "userLevel": 1,
- "corporateId": 12345,
- "statements": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves past searched coaches.
From routes/learner/coach-search.js - calls coachSearchController.getPastSearchedCoaches
Backed by controller coachSearchController.getPastSearchedCoaches.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves engaged coaches.
From routes/learner/coach-search.js - calls coachSearchController.getEngagedCoaches
Backed by controller coachSearchController.getEngagedCoaches.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach search statements.
From routes/learner/coach-search.js - calls coachSearchController.getCoachSearchStatements
Backed by controller coachSearchController.getCoachSearchStatements.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coach public profile data.
From routes/learner/coach-search.js - calls coachProfileController.getPublicProfileData
Backed by controller coachProfileController.getPublicProfileData.
| coachId | number Coach's user ID |
{- "coachId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves discovery sessions.
From routes/learner/coach-search.js - calls coachSearchController.getDiscoverySessions
Backed by controller coachSearchController.getDiscoverySessions.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits discovery feedback.
From routes/learner/coach-search.js - calls coachSearchController.submitDiscoveryFeedback. No auth middleware.
Backed by controller coachSearchController.submitDiscoveryFeedback..
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| comment | string Comment field |
| feedbackType | number Feedback type field |
| ableToRelateMyNeed | boolean Able to relate my need field |
| approachToSession | boolean Approach to session field |
| likedSessionStructure | boolean Liked session structure field |
| empathetic | boolean Empathetic field |
| goodListener | boolean Good listener field |
| coachingStyle | boolean Coaching style field |
| buildRapport | boolean Build rapport field |
| relevantQuestions | boolean Relevant questions field |
| comfortableOpening | boolean Comfortable opening field |
{- "userId": 12345,
- "sessionId": 12345,
- "comment": "sample comment",
- "feedbackType": 1,
- "ableToRelateMyNeed": true,
- "approachToSession": true,
- "likedSessionStructure": true,
- "empathetic": true,
- "goodListener": true,
- "coachingStyle": true,
- "buildRapport": true,
- "relevantQuestions": true,
- "comfortableOpening": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves calculate learner profile completeness percentage.
From routes/learner/home.js - calls coachHomeController.getProfileCompletePercentage
Backed by controller coachHomeController.getProfileCompletePercentage.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users (GET variant, legacy).
From routes/learner/home.js - calls coachHomeController.getConnectedUsers (userRole=Coachee). TODO remove after UI change.
Backed by controller coachHomeController.getConnectedUsers.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves connected users.
From routes/learner/home.js - calls coachHomeController.getConnectedUsers (userRole=Coachee)
Backed by controller coachHomeController.getConnectedUsers.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user details (coach details for a learner).
From routes/learner/home.js - calls coachHomeController.getUserDetails (userRole=Coachee)
Backed by controller coachHomeController.getUserDetails.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves upcoming sessions for learner.
From routes/learner/home.js - calls coachHomeController.getUpcomingSessions (userRole=Coachee)
Backed by controller coachHomeController.getUpcomingSessions.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves pending activities for learner.
From routes/learner/home.js - calls coachHomeController.getPendingActivities (userRole=Coachee)
Backed by controller coachHomeController.getPendingActivities.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user calendar availabilities.
From routes/learner/home.js - calls coachHomeController.getUsersAvailabilitiesNew
Backed by controller coachHomeController.getUsersAvailabilitiesNew.
| userId | number Internal user ID (foreign key) |
| userRole | string Enum: "admin" "coach" "coachee" "manager" "groupadmin" "superadmin" Application role of the user |
{- "userId": 12345,
- "userRole": "coach"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user's default video conference info.
From routes/learner/home.js - calls coachHomeController.getUsersDefaultVcInfo
Backed by controller coachHomeController.getUsersDefaultVcInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user goals.
From routes/learner/home.js - calls coachHomeController.getUserGoals (userRole=Coachee)
Backed by controller coachHomeController.getUserGoals.
| userId | number Internal user ID (foreign key) |
| coachId | number Coach's user ID |
{- "userId": 12345,
- "coachId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Checks if last session feedback is given.
From routes/learner/home.js - calls coachHomeController.isSessionFeedbackGiven (userRole=Coachee)
Backed by controller coachHomeController.isSessionFeedbackGiven.
| userId | number Internal user ID (foreign key) |
{- "userId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves platform feedback options.
From routes/learner/home.js - calls coachHomeController.showPlatformFeedback
Backed by controller coachHomeController.showPlatformFeedback.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits platform feedback.
From routes/learner/home.js - calls coachHomeController.submitPlatformFeedback
Backed by controller coachHomeController.submitPlatformFeedback.
| rating | number Rating field |
| feedback | string Feedback field |
| easeOfUsage | boolean Ease of usage field |
| usefullness | boolean Usefullness field |
| goalAchievement | boolean Goal achievement field |
| progress | boolean Progress percentage (0-100) |
| valueOfTime | boolean Value of time field |
| valueOfService | boolean Value of service field |
{- "rating": 1,
- "feedback": "sample feedback",
- "easeOfUsage": true,
- "usefullness": true,
- "goalAchievement": true,
- "progress": true,
- "valueOfTime": true,
- "valueOfService": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits view report (handler not implemented in controller).
From routes/learner/home.js - calls coachHomeController.viewReport
Backed by controller coachHomeController.viewReport.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves active programs for learner.
From routes/learner/home.js - calls learnerHomeController.getActivePrograms
Backed by controller learnerHomeController.getActivePrograms.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves program info (with components and health).
From routes/learner/home.js - calls learnerHomeController.getProgramInfo
Backed by controller learnerHomeController.getProgramInfo.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves program insights for learner.
From routes/learner/home.js - calls learnerHomeController.getProgramInsights
Backed by controller learnerHomeController.getProgramInsights.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves assessment info for learner.
From routes/learner/home.js - calls learnerHomeController.getAssessmentInfo
Backed by controller learnerHomeController.getAssessmentInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves development plan (AI-generated).
From routes/learner/home.js - calls learnerHomeController.getDevelopmentPlan
Backed by controller learnerHomeController.getDevelopmentPlan.
| toolId | number Coaching tool ID |
| blindSpots | Array of objects Blind spots field |
{- "toolId": 12345,
- "blindSpots": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves learner leaderboard.
From routes/learner/home.js - calls learnerHomeController.getLeaderboard
Backed by controller learnerHomeController.getLeaderboard.
| programId | number Program ID |
{- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Sends email/query to admin.
From routes/learner/home.js - calls learnerHomeController.sendEmailToAdmin
Backed by controller learnerHomeController.sendEmailToAdmin.
| programId | number Program ID |
| subject | string Subject field |
| description | string Description field |
{- "programId": 12345,
- "subject": "sample subject",
- "description": "sample description"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves filter options for learner insights.
From routes/learner/insights.js - calls learnerInsightsController.getFilterData
Backed by controller learnerInsightsController.getFilterData.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves learner insight statistics.
From routes/learner/insights.js - calls learnerInsightsController.getLeanerInsightStatistics
Backed by controller learnerInsightsController.getLeanerInsightStatistics.
| userId | number Internal user ID (foreign key) |
| programId | number Program ID |
| startDate | string <date> Start date (ISO 8601) |
| endDate | string <date> End date (ISO 8601) |
| sessionType | string Session type field |
{- "userId": 12345,
- "programId": 12345,
- "startDate": "2026-05-13",
- "endDate": "2026-05-13",
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves engagement notes for a user.
From routes/learner/notes.js - calls coachNoteController.GetEngagementNotes
Backed by controller coachNoteController.GetEngagementNotes.
| engagementId | number Engagement ID |
| engagementType | string Engagement type field |
{- "engagementId": 12345,
- "engagementType": "sample engagement type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves session notes.
From routes/learner/notes.js - calls coachNoteController.GetSessionNotes
Backed by controller coachNoteController.GetSessionNotes.
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates a note.
From routes/learner/notes.js - calls coachNoteController.AddUpdateNote
Backed by controller coachNoteController.AddUpdateNote.
| noteId | number Note ID |
| noteType | string Note type field |
| noteTitle | string Note title field |
| textNote | string Text note field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "noteId": 12345,
- "noteType": "sample note type",
- "noteTitle": "sample note title",
- "textNote": "sample text note",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates a note.
From routes/learner/notes.js - calls coachNoteController.AddUpdateNote
Backed by controller coachNoteController.AddUpdateNote.
| noteId | number Note ID |
| noteType | string Note type field |
| noteTitle | string Note title field |
| textNote | string Text note field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "noteId": 12345,
- "noteType": "sample note type",
- "noteTitle": "sample note title",
- "textNote": "sample text note",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates note summary.
From routes/learner/notes.js - calls coachNoteController.updateNoteSummary
Backed by controller coachNoteController.updateNoteSummary.
| noteId | number Note ID |
| noteSummary | string Note summary field |
{- "noteId": 12345,
- "noteSummary": "sample note summary"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a note.
From routes/learner/notes.js - calls coachNoteController.DeleteNote
Backed by controller coachNoteController.DeleteNote.
| noteId | number Note ID |
{- "noteId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Uploads voice note resource (resourceType=VOICE).
From routes/learner/notes.js - calls coachNoteController.UploadNoteResource
Backed by controller coachNoteController.UploadNoteResource.
| resourceTitle | string Resource title field |
| fileName | string File name field |
| filePath | string File path field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "resourceTitle": "sample resource title",
- "fileName": "sample file name",
- "filePath": "sample file path",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Uploads file note resource (resourceType=FILE).
From routes/learner/notes.js - calls coachNoteController.UploadNoteResource
Backed by controller coachNoteController.UploadNoteResource.
| resourceTitle | string Resource title field |
| fileName | string File name field |
| filePath | string File path field |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "resourceTitle": "sample resource title",
- "fileName": "sample file name",
- "filePath": "sample file path",
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates learner profile image.
From routes/learner/profile.js - calls coachProfileController.updateProfileImage
Backed by controller coachProfileController.updateProfileImage.
| profileImage | string Profile image field |
{- "profileImage": "sample profile image"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves learner education info.
From routes/learner/profile.js - calls coachProfileController.educationInfo
Backed by controller coachProfileController.educationInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates learner education info.
From routes/learner/profile.js - calls coachProfileController.addEducationInfo
Backed by controller coachProfileController.addEducationInfo.
| studyField | string Study field field |
| qualification | string Qualification field |
| university | string University field |
{- "studyField": "sample study field",
- "qualification": "sample qualification",
- "university": "sample university"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes learner education info.
From routes/learner/profile.js - calls coachProfileController.removeEducationInfo
Backed by controller coachProfileController.removeEducationInfo.
| educationInfo | object Education info field |
{- "educationInfo": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates learner organization info.
From routes/learner/profile.js - calls coachProfileController.addOrganizationInfo
Backed by controller coachProfileController.addOrganizationInfo.
| organizationsWorked | Array of objects Organizations worked field |
{- "organizationsWorked": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes learner organization info.
From routes/learner/profile.js - calls coachProfileController.removeOrganizationInfo
Backed by controller coachProfileController.removeOrganizationInfo.
| organizationName | string Organization name field |
{- "organizationName": "sample organization name"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves learner corporate experience info.
From routes/learner/profile.js - calls coachProfileController.getUserCorporateInfo
Backed by controller coachProfileController.getUserCorporateInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates learner corporate experience info.
From routes/learner/profile.js - calls coachProfileController.updateUserCorporateInfo
Backed by controller coachProfileController.updateUserCorporateInfo.
| corporateExp | number Corporate exp field |
| corporateExpYear | number Corporate exp year field |
| corporateExpMonth | number Corporate exp month field |
| industries | Array of objects Industries field |
| functions | Array of objects Functions field |
| currentRole | number Current role field |
| designation | string Designation field |
| organizationsWorked | Array of objects Organizations worked field |
{- "corporateExp": 1,
- "corporateExpYear": 1,
- "corporateExpMonth": 1,
- "industries": [ ],
- "functions": [ ],
- "currentRole": 1,
- "designation": "sample designation",
- "organizationsWorked": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves learner profile progress info.
From routes/learner/profile.js - calls coachProfileController.getProfileProgressInfo
Backed by controller coachProfileController.getProfileProgressInfo.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves learner calendar status info.
From routes/learner/profile.js - calls coachProfileController.getCalendarStatus (userRole forced to Learner)
Backed by controller coachProfileController.getCalendarStatus.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Creates (create) session.
From routes/learner/session.js - calls coachSessionController.createSession (userRole=Coachee)
Backed by controller coachSessionController.createSession.
| coachId | number Coach's user ID |
| userId | number Internal user ID (foreign key) |
| engagementId | number Engagement ID |
| programId | number Program ID |
| sessionName | string Session name field |
| sessionDesc | string Session desc field |
| sessionType | string Session type field |
| startDateTime | string <date-time> Start date time field |
| endDateTime | string <date-time> End date time field |
| duration | number Duration field |
| timezone | string Timezone field |
| sessionMode | number Session mode field |
| vcToolType | string Vc tool type field |
| vcToolLink | string Vc tool link field |
| location | string Location field |
| comment | string Comment field |
{- "coachId": 12345,
- "userId": 12345,
- "engagementId": 12345,
- "programId": 12345,
- "sessionName": "sample session name",
- "sessionDesc": "sample session desc",
- "sessionType": "sample session type",
- "startDateTime": "2026-05-13T09:00:00.000Z",
- "endDateTime": "2026-05-13T09:00:00.000Z",
- "duration": 1,
- "timezone": "sample timezone",
- "sessionMode": 1,
- "vcToolType": "sample vc tool type",
- "vcToolLink": "sample vc tool link",
- "location": "sample location",
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates session name.
From routes/learner/session.js - calls coachSessionController.updateSessionName (userRole=Coachee)
Backed by controller coachSessionController.updateSessionName.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionName | string Session name field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionName": "sample session name"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits reschedule a session.
From routes/learner/session.js - calls coachSessionController.rescheduleSession (userRole=Coachee). No auth middleware.
Backed by controller coachSessionController.rescheduleSession.
| sessionId | number Session ID |
| sessionType | string Session type field |
| startDateTime | string <date-time> Start date time field |
| endDateTime | string <date-time> End date time field |
| timezone | string Timezone field |
| comment | string Comment field |
| sessionName | string Session name field |
| sessionMode | number Session mode field |
| vcType | string Vc type field |
| meetingUrl | string <uri> Meeting url field |
| saveAsDefaultVcLink | boolean Save as default vc link field |
| location | string Location field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "startDateTime": "2026-05-13T09:00:00.000Z",
- "endDateTime": "2026-05-13T09:00:00.000Z",
- "timezone": "sample timezone",
- "comment": "sample comment",
- "sessionName": "sample session name",
- "sessionMode": 1,
- "vcType": "sample vc type",
- "saveAsDefaultVcLink": true,
- "location": "sample location"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Removes a session.
From routes/learner/session.js - calls coachSessionController.cancelSession (userRole=Coachee). No auth middleware.
Backed by controller coachSessionController.cancelSession.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| comment | string Comment field |
{- "userId": 12345,
- "sessionId": 12345,
- "comment": "sample comment"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Accepts a session (learner).
From routes/learner/session.js - calls learnerSessionController.learnerAcceptSession. No auth middleware.
Backed by controller learnerSessionController.learnerAcceptSession..
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
{- "userId": 12345,
- "sessionId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves session meeting info.
From routes/learner/session.js - calls coachSessionController.GetSessionMeetingInfo. No auth middleware.
Backed by controller coachSessionController.GetSessionMeetingInfo..
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves user feedback info for a session.
From routes/learner/session.js - calls coachSessionController.getUserFeedbackInfo (userRole=Coachee)
Backed by controller coachSessionController.getUserFeedbackInfo.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits submit session feedback (routes to OneOnOne, Group, or Workshop based on sessionType). From routes/learner/session.js - dispatches to learnerSessionController.submitSessionFeedback or submitGroupSessionFeedback. No auth middleware.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
| rating | number Rating field |
| comment | string Comment field |
| coachHelpedToProgress | boolean Coach helped to progress field |
| actionPlansHelped | boolean Action plans helped field |
| coachAndIWorkedOnMyGoals | boolean Coach and iworked on my goals field |
| timeSpentEfficiently | boolean Time spent efficiently field |
| usefulActivities | boolean Useful activities field |
| understoodByMyCoach | boolean Understood by my coach field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type",
- "rating": 1,
- "comment": "sample comment",
- "coachHelpedToProgress": true,
- "actionPlansHelped": true,
- "coachAndIWorkedOnMyGoals": true,
- "timeSpentEfficiently": true,
- "usefulActivities": true,
- "understoodByMyCoach": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits group session feedback.
From routes/learner/session.js - calls learnerSessionController.submitGroupSessionFeedback. No auth middleware.
Backed by controller learnerSessionController.submitGroupSessionFeedback..
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
| rating | number Rating field |
| comment | string Comment field |
| coachHelpedToProgress | boolean Coach helped to progress field |
| coachWorkedOnOurGoals | boolean Coach worked on our goals field |
| feltConnectedWithCoach | boolean Felt connected with coach field |
| feltUnderstoodByCoach | boolean Felt understood by coach field |
| timeSpentEfficiently | boolean Time spent efficiently field |
| usefulActivities | boolean Useful activities field |
| comfortableWithOtherMembers | boolean Comfortable with other members field |
| knowledgeSharingInGroup | boolean Knowledge sharing in group field |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type",
- "rating": 1,
- "comment": "sample comment",
- "coachHelpedToProgress": true,
- "coachWorkedOnOurGoals": true,
- "feltConnectedWithCoach": true,
- "feltUnderstoodByCoach": true,
- "timeSpentEfficiently": true,
- "usefulActivities": true,
- "comfortableWithOtherMembers": true,
- "knowledgeSharingInGroup": true
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits workshop session feedback.
From routes/learner/session.js - calls learnerSessionController.submitWorkSessionFeedback. No auth middleware.
Backed by controller learnerSessionController.submitWorkSessionFeedback..
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| achieveObjectives | number Achieve objectives field |
| contentRelevance | number Content relevance field |
| alignedExpectations | number Aligned expectations field |
| effectiveActivities | number Effective activities field |
| toolsAndApproaches | number Tools and approaches field |
| actionStepsClarity | number Action steps clarity field |
| facilitatorEnvironment | number Facilitator environment field |
| feltHeardAndIncluded | number Felt heard and included field |
| facilitatorEffectiveness | number Facilitator effectiveness field |
| keyInsight | string Key insight field |
| furtherLearning | string Further learning field |
| workshopImprovement | string Workshop improvement field |
| rating | number Rating field |
{- "userId": 12345,
- "sessionId": 12345,
- "achieveObjectives": 1,
- "contentRelevance": 1,
- "alignedExpectations": 1,
- "effectiveActivities": 1,
- "toolsAndApproaches": 1,
- "actionStepsClarity": 1,
- "facilitatorEnvironment": 1,
- "feltHeardAndIncluded": 1,
- "facilitatorEffectiveness": 1,
- "keyInsight": "sample key insight",
- "furtherLearning": "sample further learning",
- "workshopImprovement": "sample workshop improvement",
- "rating": 1
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits view session reflection.
From routes/learner/session.js - calls coachSessionController.getSessionReflection
Backed by controller coachSessionController.getSessionReflection.
| sessionId | number Session ID |
| sessionType | string Session type field |
{- "sessionId": 12345,
- "sessionType": "sample session type"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates meeting info on a session.
From routes/learner/session.js - calls coachSessionController.updateMeetingInfo
Backed by controller coachSessionController.updateMeetingInfo.
| sessionId | number Session ID |
| sessionType | string Session type field |
| invities | Array of objects Invities field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "invities": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits mark session joined by coachee.
From routes/learner/session.js - calls coachSessionController.markSessionJoinedByCoachee (userRole=Coachee)
Backed by controller coachSessionController.markSessionJoinedByCoachee.
| userId | number Internal user ID (foreign key) |
| sessionId | number Session ID |
| sessionType | string Session type field |
| calType | string Cal type field |
| eventId | string <uuid> Event id (identifier) |
{- "userId": 12345,
- "sessionId": 12345,
- "sessionType": "sample session type",
- "calType": "sample cal type",
- "eventId": "550e8400-e29b-41d4-a716-446655440000"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Checks if AI coaching is allowed.
From routes/learner/session.js - calls learnerSessionController.isAICoachingAllowed
Backed by controller learnerSessionController.isAICoachingAllowed.
{ }{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Starts an AI coaching session.
From routes/learner/session.js - calls learnerSessionController.startAICoachingSession
Backed by controller learnerSessionController.startAICoachingSession.
| sessionId | string <uuid> Session ID |
| programId | number Program ID |
{- "sessionId": "550e8400-e29b-41d4-a716-446655440000",
- "programId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Ends an AI coaching session.
From routes/learner/session.js - calls learnerSessionController.endAICoachingSession
Backed by controller learnerSessionController.endAICoachingSession.
| sessionId | string <uuid> Session ID |
{- "sessionId": "550e8400-e29b-41d4-a716-446655440000"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Saves aI coaching session data.
From routes/learner/session.js - calls learnerSessionController.saveAICoachingSessionData
Backed by controller learnerSessionController.saveAICoachingSessionData.
| sessionId | string <uuid> Session ID |
| saveSessionData | boolean Save session data field |
| summary | object Summary field |
| goals | Array of objects Goals field |
| actions | Array of objects Actions field |
{- "sessionId": "550e8400-e29b-41d4-a716-446655440000",
- "saveSessionData": true,
- "summary": { },
- "goals": [ ],
- "actions": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Updates aI coaching session rating.
From routes/learner/session.js - calls learnerSessionController.updateAICoachingSessionRating
Backed by controller learnerSessionController.updateAICoachingSessionRating.
| sessionId | string <uuid> Session ID |
| rating | string Rating field |
{- "sessionId": "550e8400-e29b-41d4-a716-446655440000",
- "rating": "sample rating"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Invites a user to users to a session.
From routes/learner/session.js - calls coachSessionController.inviteSessionUsers
Backed by controller coachSessionController.inviteSessionUsers.
| sessionId | number Session ID |
| sessionType | string Session type field |
| invitedUsers | Array of objects Invited users field |
{- "sessionId": 12345,
- "sessionType": "sample session type",
- "invitedUsers": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves coaching tools for coachee.
From routes/learner/coaching_tool.js - calls coachingToolController.GetCoachingToolsForCoachee
Backed by controller coachingToolController.GetCoachingToolsForCoachee.
{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool instance details.
From routes/learner/coaching_tool.js - calls coachingToolController.GetToolInstanceDetails
Backed by controller coachingToolController.GetToolInstanceDetails.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Saves coaching tool instance (draft).
From routes/learner/coaching_tool.js - calls coachingToolController.SaveCoachingToolInstance
Backed by controller coachingToolController.SaveCoachingToolInstance.
| toolId | number Coaching tool ID |
| toolStructure | object Tool structure field |
{- "toolId": 12345,
- "toolStructure": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits coaching tool (coachee).
From routes/learner/coaching_tool.js - calls coachingToolController.SubmitCoachingToolByCoachee
Backed by controller coachingToolController.SubmitCoachingToolByCoachee.
| toolId | number Coaching tool ID |
| toolStructure | object Tool structure field |
{- "toolId": 12345,
- "toolStructure": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves stakeholder sharing report.
From routes/learner/coaching_tool.js - calls coachingToolController.GetStakeHolderSharingReport
Backed by controller coachingToolController.GetStakeHolderSharingReport.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves tool details using access key (public).
From routes/learner/coaching_tool.js - calls coachingToolController.GetToolDetailsWithAccessKey. No auth middleware.
Backed by controller coachingToolController.GetToolDetailsWithAccessKey..
| accessKey | string Access key field |
{- "accessKey": "sample access key"
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Saves tool using access key (public).
From routes/learner/coaching_tool.js - calls coachingToolController.SaveCoachingToolWithAccessKey. No auth middleware.
Backed by controller coachingToolController.SaveCoachingToolWithAccessKey..
| accessKey | string Access key field |
| isAnonymous | boolean Is anonymous field |
| toolStructure | object Tool structure field |
{- "accessKey": "sample access key",
- "isAnonymous": true,
- "toolStructure": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits tool using access key (public).
From routes/learner/coaching_tool.js - calls coachingToolController.SubmitCoachingToolWithAccessKey. No auth middleware.
Backed by controller coachingToolController.SubmitCoachingToolWithAccessKey..
| accessKey | string Access key field |
| isAnonymous | boolean Is anonymous field |
| toolStructure | object Tool structure field |
{- "accessKey": "sample access key",
- "isAnonymous": true,
- "toolStructure": { }
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Sends reminder to stakeholder to submit.
From routes/learner/coaching_tool.js - calls coachingToolController.SendReminderToStakeHolderToSubmit
Backed by controller coachingToolController.SendReminderToStakeHolderToSubmit.
| toolId | number Coaching tool ID |
| stakeHolderId | Array of numbers Stake holder id (identifier) |
{- "toolId": 12345,
- "stakeHolderId": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Submits recall tool from stakeholders.
From routes/learner/coaching_tool.js - calls coachingToolController.RecallToolForStakeholders
Backed by controller coachingToolController.RecallToolForStakeholders.
| toolId | number Coaching tool ID |
| stakeHolderId | Array of numbers Stake holder id (identifier) |
{- "toolId": 12345,
- "stakeHolderId": [ ]
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}Retrieves self tool report (coachee).
From routes/learner/coaching_tool.js - calls coachingToolController.GetCoacheeSelfToolReport
Backed by controller coachingToolController.GetCoacheeSelfToolReport.
| toolId | number Coaching tool ID |
{- "toolId": 12345
}{- "result": "SUCCESS",
- "message": "Operation completed",
- "data": { }
}