Authentication
Diagnostic Module
Mentorship Module
Microlearning Module
Recognition Module
Correlation Module
curl -X POST https://api.cuido.com/api/employees \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"personalInfo": {
"name": "Dr. María García",
"email": "[email protected]",
"identification": "123456789",
"phoneNumber": "+57 300 123 4567"
},
"jobInfo": {
"position": "medico",
"department": "urgencias",
"startDate": "2024-01-15T00:00:00.000Z",
"shift": "noche"
},
"hospitalId": "HOSP001"
}'
{
"success": true,
"message": "Empleado creado exitosamente",
"data": {
"employee": {
"_id": "60d5ec49f1b2c72b8c8e4f1a",
"personalInfo": {
"name": "Dr. María García",
"email": "[email protected]",
"identification": "123456789",
"phoneNumber": "+57 300 123 4567"
},
"jobInfo": {
"position": "medico",
"department": "urgencias",
"startDate": "2024-01-15T00:00:00.000Z",
"shift": "noche"
},
"hospitalId": "HOSP001",
"wellnessMetrics": {
"currentMoodScore": 3,
"averageWorkload": 3,
"teamSupportScore": 3,
"satisfactionScore": 5,
"riskLevel": "bajo"
},
"gamification": {
"totalPoints": 0,
"currentStreak": 0,
"maxStreak": 0,
"level": 1,
"badges": []
},
"isActive": true,
"createdAt": "2024-03-05T10:30:00.000Z",
"updatedAt": "2024-03-05T10:30:00.000Z"
}
}
}
Employees
Create Employee
Create a new employee record in the system
POST
/
api
/
employees
curl -X POST https://api.cuido.com/api/employees \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"personalInfo": {
"name": "Dr. María García",
"email": "[email protected]",
"identification": "123456789",
"phoneNumber": "+57 300 123 4567"
},
"jobInfo": {
"position": "medico",
"department": "urgencias",
"startDate": "2024-01-15T00:00:00.000Z",
"shift": "noche"
},
"hospitalId": "HOSP001"
}'
{
"success": true,
"message": "Empleado creado exitosamente",
"data": {
"employee": {
"_id": "60d5ec49f1b2c72b8c8e4f1a",
"personalInfo": {
"name": "Dr. María García",
"email": "[email protected]",
"identification": "123456789",
"phoneNumber": "+57 300 123 4567"
},
"jobInfo": {
"position": "medico",
"department": "urgencias",
"startDate": "2024-01-15T00:00:00.000Z",
"shift": "noche"
},
"hospitalId": "HOSP001",
"wellnessMetrics": {
"currentMoodScore": 3,
"averageWorkload": 3,
"teamSupportScore": 3,
"satisfactionScore": 5,
"riskLevel": "bajo"
},
"gamification": {
"totalPoints": 0,
"currentStreak": 0,
"maxStreak": 0,
"level": 1,
"badges": []
},
"isActive": true,
"createdAt": "2024-03-05T10:30:00.000Z",
"updatedAt": "2024-03-05T10:30:00.000Z"
}
}
}
Authentication
Bearer token for authentication
This endpoint requires admin privileges.
Request Body
Personal information about the employee
Show personalInfo properties
Show personalInfo properties
Employment and role information
Show jobInfo properties
Show jobInfo properties
Employee position. Must be one of:
medico- Doctorenfermero- Nurseauxiliar_enfermeria- Nursing assistantadministrativo- Administrative staffotro- Other
Department assignment. Must be one of:
urgencias- Emergencyhospitalizacion- Hospitalizationconsulta_externa- Outpatientadministracion- Administrationotro- Other
Employment start date in ISO 8601 format (e.g.,
2024-01-15T00:00:00.000Z)Work shift. Must be one of:
mañana- Morning (default)tarde- Afternoonnoche- Nightrotativo- Rotating
Identifier of the hospital this employee belongs to
Initial wellness metrics (optional, defaults provided)
Show wellnessMetrics properties
Show wellnessMetrics properties
Current mood rating (default: 3)
Average workload score (default: 3)
Team support perception score (default: 3)
Job satisfaction score (default: 5)
Burnout risk level. One of:
bajo, medio, alto (default: bajo)Initial gamification data (optional, defaults provided)
Show gamification properties
Show gamification properties
Total points earned (default: 0)
Current consecutive days streak (default: 0)
Maximum streak achieved (default: 0)
Current level (default: 1)
Array of badge objects (default: [])
Whether the employee is currently active (default: true)
Response
Indicates if the request was successful
Success message
Response data
Show data properties
Show data properties
The created employee object with all fields including generated
_id, createdAt, and updatedAtcurl -X POST https://api.cuido.com/api/employees \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"personalInfo": {
"name": "Dr. María García",
"email": "[email protected]",
"identification": "123456789",
"phoneNumber": "+57 300 123 4567"
},
"jobInfo": {
"position": "medico",
"department": "urgencias",
"startDate": "2024-01-15T00:00:00.000Z",
"shift": "noche"
},
"hospitalId": "HOSP001"
}'
{
"success": true,
"message": "Empleado creado exitosamente",
"data": {
"employee": {
"_id": "60d5ec49f1b2c72b8c8e4f1a",
"personalInfo": {
"name": "Dr. María García",
"email": "[email protected]",
"identification": "123456789",
"phoneNumber": "+57 300 123 4567"
},
"jobInfo": {
"position": "medico",
"department": "urgencias",
"startDate": "2024-01-15T00:00:00.000Z",
"shift": "noche"
},
"hospitalId": "HOSP001",
"wellnessMetrics": {
"currentMoodScore": 3,
"averageWorkload": 3,
"teamSupportScore": 3,
"satisfactionScore": 5,
"riskLevel": "bajo"
},
"gamification": {
"totalPoints": 0,
"currentStreak": 0,
"maxStreak": 0,
"level": 1,
"badges": []
},
"isActive": true,
"createdAt": "2024-03-05T10:30:00.000Z",
"updatedAt": "2024-03-05T10:30:00.000Z"
}
}
}
⌘I
Build docs developers (and LLMs) love
Assistant
Responses are generated using AI and may contain mistakes.