Mentor Visibility Suppressor - API Contract

GET /api/v1/mentor-suppressions/api/v1/mentor-suppressions

List suppressed mentors. Filter by coordinator to get their suppressed mentors only.

Public

Response Example

{
  "data": [
    {
      "suppression_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "mentor_id": "mentor_james_okafor",
      "coordinator_id": "coord_maya_patel",
      "reason": "certification_expired",
      "suppressed_at": "2026-03-26T00:01:00Z",
      "restored_at": null,
      "is_active": true
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

GET /api/v1/mentor-suppressions/api/v1/mentor-suppressions/:mentor_id

Get the current suppression status for a specific mentor.

Public

Response Example

{
  "suppression_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "mentor_id": "mentor_james_okafor",
  "coordinator_id": "coord_maya_patel",
  "reason": "certification_expired",
  "suppressed_at": "2026-03-26T00:01:00Z",
  "restored_at": null,
  "is_active": true
}

POST /api/v1/mentor-suppressions/api/v1/mentor-suppressions

Suppress a mentor from public listings due to expired certification.

Public

Request Example

{
  "mentor_id": "mentor_james_okafor",
  "coordinator_id": "coord_maya_patel",
  "reason": "certification_expired"
}

Response Example

{
  "suppression_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "mentor_id": "mentor_james_okafor",
  "coordinator_id": "coord_maya_patel",
  "reason": "certification_expired",
  "suppressed_at": "2026-03-26T00:01:00Z",
  "restored_at": null,
  "is_active": true
}

PUT /api/v1/mentor-suppressions/api/v1/mentor-suppressions/:mentor_id

Restore mentor visibility or update suppression metadata.

Public

Request Example

{
  "is_active": false,
  "restored_at": "2026-04-16T09:00:00Z",
  "restore_reason": "certification_renewed"
}

Response Example

{
  "suppression_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "mentor_id": "mentor_james_okafor",
  "coordinator_id": "coord_maya_patel",
  "reason": "certification_expired",
  "suppressed_at": "2026-03-26T00:01:00Z",
  "restored_at": "2026-04-16T09:00:00Z",
  "is_active": false
}

DELETE /api/v1/mentor-suppressions/api/v1/mentor-suppressions/:mentor_id

Permanently remove a suppression record (hard restore).

Public

Response Example

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

Additional Metadata

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