Reviewee

Register the authenticated user as a Reviewee

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

displayNamestringOptional

preferencesstring[]Optional

Responses

200

Reviewee registered successfully

application/json

codestringOptional

messagestringOptional

400

Invalid request or user already a reviewee

401

Unauthorized

post

/api/v1/reviewee

HTTPcURLJavaScriptPython

POST /api/v1/reviewee HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "displayName": "text",
  "preferences": [
    "text"
  ]
}

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "userId": 1,
    "displayName": "text",
    "preferences": [
      "text"
    ],
    "createdAt": "2026-03-03T01:54:08.510Z",
    "updatedAt": "2026-03-03T01:54:08.510Z"
  }
}

Get Reviewee details by ID

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int64Required

ID of the Reviewee

Responses

200

Reviewee data retrieved

application/json

codestringOptional

messagestringOptional

401

Unauthorized

404

Reviewee not found

get

/api/v1/reviewee/{id}

HTTPcURLJavaScriptPython

GET /api/v1/reviewee/{id} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "userId": 1,
    "displayName": "text",
    "preferences": [
      "text"
    ],
    "createdAt": "2026-03-03T01:54:08.510Z",
    "updatedAt": "2026-03-03T01:54:08.510Z"
  }
}

Update Reviewee details

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int64Required

ID of the Reviewee to update (must match authenticated user's reviewee profile or be admin)

Body

application/json

displayNamestringOptional

preferencesstring[]Optional

Responses

200

Reviewee updated successfully

application/json

codestringOptional

messagestringOptional

400

Invalid request

401

Unauthorized

403

Forbidden (not allowed to update this reviewee)

404

Reviewee not found

put

/api/v1/reviewee/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/reviewee/{id} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "displayName": "text",
  "preferences": [
    "text"
  ]
}

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "userId": 1,
    "displayName": "text",
    "preferences": [
      "text"
    ],
    "createdAt": "2026-03-03T01:54:08.510Z",
    "updatedAt": "2026-03-03T01:54:08.510Z"
  }
}