Peer Mentor Repository - API Contract

GET /api/v1/peer-mentors/api/v1/peer-mentors

List peer mentors by organization

Public

Response Example

{
  "data": [
    {
      "mentor_id": "mentor_a1b2c3",
      "full_name": "Kari Nordmann",
      "email": "kari.nordmann@frivillig.no",
      "org_id": "org_x9y8z7",
      "status": "active",
      "is_hlf": false,
      "is_paused": false,
      "certification_expiry_date": "2026-11-15T00:00:00Z",
      "created_at": "2024-03-10T08:30:00Z",
      "updated_at": "2025-09-01T14:22:00Z"
    },
    {
      "mentor_id": "mentor_d4e5f6",
      "full_name": "Ole Hansen",
      "email": "ole.hansen@frivillig.no",
      "org_id": "org_x9y8z7",
      "status": "warning",
      "is_hlf": false,
      "is_paused": false,
      "certification_expiry_date": "2026-04-10T00:00:00Z",
      "created_at": "2023-07-22T09:00:00Z",
      "updated_at": "2026-03-01T11:05:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 48
  }
}

GET /api/v1/peer-mentors/api/v1/peer-mentors/:id

Get a single peer mentor by ID

Public

Response Example

{
  "mentor_id": "mentor_a1b2c3",
  "full_name": "Kari Nordmann",
  "email": "kari.nordmann@frivillig.no",
  "org_id": "org_x9y8z7",
  "status": "active",
  "is_hlf": false,
  "is_paused": false,
  "phone": "+47 912 34 567",
  "certification_expiry_date": "2026-11-15T00:00:00Z",
  "created_at": "2024-03-10T08:30:00Z",
  "updated_at": "2025-09-01T14:22:00Z"
}

POST /api/v1/peer-mentors/api/v1/peer-mentors

Create a new peer mentor

Public

Request Example

{
  "full_name": "Ingrid Berg",
  "email": "ingrid.berg@frivillig.no",
  "phone": "+47 987 65 432",
  "org_id": "org_x9y8z7",
  "is_hlf": false,
  "certification_expiry_date": "2027-06-01T00:00:00Z"
}

Response Example

{
  "mentor_id": "mentor_g7h8i9",
  "full_name": "Ingrid Berg",
  "email": "ingrid.berg@frivillig.no",
  "org_id": "org_x9y8z7",
  "status": "active",
  "is_hlf": false,
  "is_paused": false,
  "certification_expiry_date": "2027-06-01T00:00:00Z",
  "created_at": "2026-03-26T10:00:00Z",
  "updated_at": "2026-03-26T10:00:00Z"
}

PUT /api/v1/peer-mentors/api/v1/peer-mentors/:id

Update peer mentor profile

Public

Request Example

{
  "full_name": "Kari Nordmann-Olsen",
  "email": "kari.no@frivillig.no",
  "phone": "+47 912 34 567",
  "is_hlf": true
}

Response Example

{
  "mentor_id": "mentor_a1b2c3",
  "full_name": "Kari Nordmann-Olsen",
  "email": "kari.no@frivillig.no",
  "org_id": "org_x9y8z7",
  "status": "active",
  "is_hlf": true,
  "is_paused": false,
  "certification_expiry_date": "2026-11-15T00:00:00Z",
  "updated_at": "2026-03-26T10:15:00Z"
}

DELETE /api/v1/peer-mentors/api/v1/peer-mentors/:id

Delete a peer mentor record

Public

Response Example

{
  "deleted": true,
  "mentor_id": "mentor_a1b2c3"
}

PATCH /api/v1/peer-mentors/api/v1/peer-mentors/:id/status

Update mentor status (active/paused/expired)

Public

Request Example

{
  "status": "paused",
  "reason": "On leave until April 2026"
}

Response Example

{
  "mentor_id": "mentor_a1b2c3",
  "status": "paused",
  "is_paused": true,
  "updated_at": "2026-03-26T10:20:00Z"
}

PATCH /api/v1/peer-mentors/api/v1/peer-mentors/:id/certification-expiry

Update mentor certification expiry date

Public

Request Example

{
  "expiry_date": "2027-03-15T00:00:00Z"
}

Response Example

{
  "mentor_id": "mentor_a1b2c3",
  "certification_expiry_date": "2027-03-15T00:00:00Z",
  "status": "active",
  "days_until_expiry": 354,
  "updated_at": "2026-03-26T10:25:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}