Proxy Contact List Provider
API Contract
REST
/api/v1/mentor-contacts
5 endpoints
GET
/api/v1/mentor-contacts/api/v1/mentor-contacts
List or search mentors available to a coordinator (searchMentors / watchCoordinatorMentors)
Public
Response Example
{
"data": [
{
"id": "mentor-17",
"full_name": "Alice Nguyen",
"email": "alice.nguyen@school.edu",
"area": "Mathematics",
"status": "active",
"last_activity_date": "2026-03-20"
},
{
"id": "mentor-18",
"full_name": "Ben Okafor",
"email": "ben.okafor@school.edu",
"area": "Science",
"status": "active",
"last_activity_date": "2026-03-18"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 14
}
}
GET
/api/v1/mentor-contacts/api/v1/mentor-contacts/:id
Get full mentor contact details by ID (getMentorById)
Public
Response Example
{
"id": "mentor-17",
"full_name": "Alice Nguyen",
"email": "alice.nguyen@school.edu",
"phone": "+353-87-1234567",
"area": "Mathematics",
"status": "active",
"coordinator_id": "coord-42",
"last_activity_date": "2026-03-20",
"total_activities": 8
}
POST
/api/v1/mentor-contacts/api/v1/mentor-contacts
Add a mentor to a coordinator's contact list
Public
Request Example
{
"coordinator_id": "coord-42",
"mentor_id": "mentor-25",
"notes": "New mentee assigned March 2026"
}
Response Example
{
"id": "contact-099",
"coordinator_id": "coord-42",
"mentor_id": "mentor-25",
"added_at": "2026-03-26T09:00:00Z"
}
PUT
/api/v1/mentor-contacts/api/v1/mentor-contacts/:id
Refresh or update a mentor contact entry (refreshContacts)
Public
Request Example
{
"action": "refresh",
"coordinator_id": "coord-42"
}
Response Example
{
"id": "mentor-17",
"full_name": "Alice Nguyen",
"email": "alice.nguyen@school.edu",
"area": "Mathematics",
"status": "active",
"refreshed_at": "2026-03-26T09:05:00Z"
}
DELETE
/api/v1/mentor-contacts/api/v1/mentor-contacts/:id
Remove a mentor from a coordinator's contact list
Public
Response Example
{
"message": "Mentor contact mentor-17 removed from coordinator coord-42 contact list"
}