# Candidate Status

GET $BASE_URL/portal/invite/{$assessment_code}?limit={$limit}&page={$page}

# Request Payload

Field	Type	Description
`assessment_code`	Number	Serial number associate with assessment_id

Field	Type	Description
`limit`	Number	Number of Candidates details per call
`page`	Number	Page Number for Candidates details
`status` Optional	String	Current Status of Candidate Filter `Yet to Register`, `Registered`, `Ongoing`, `Expired`, `Complete`
`search` Optional	String	Candidate Filter by Search Value `invitation_id`, `email_id`

Field	Type	Description
`Authorization`	String	Authorization token from PerspectAI platform

# Response Payload

Field	Type	Description
`message`	String	Message
`data`	List[Object]	Candidate details
`data.cand_id`	String	Candidate unique user_id
`data.mobile_no`	Number	Candidate mobile number
`data.name`	String	Candidate name
`data.email_id`	String	Candidate email ID
`data.reviewers`	List[String]	Assigned reviewer to Candidate
`data.status`	String	Current status of the Candidate
`data.status_reason`	String	Explanation of the status
`data.assment_id`	String	Assessment ID of the Assessment
`data.persp_score`	Number	Cumulative score of all the Cognitive Abilities
`data.profile_score`	Number	Cumulative score of all the dimensions/sections of the assessment
`data.lic_key`	String	Deprecated feature
`data.end_date`	String	Assessment Expiry Date
`data.candidate_recommendation`	String	Final Recommendation of the candidate based on the configuration
`data.invited_on`	String	Candidate invited on
`data.started_on`	String	Candidate started assessment on this date
`data.completed_on`	String	Candidate completed assessment on this date
`data.completion_status`	String	Internal status of the candidate
`data.report_seen`	Boolean	This shows if the report was accessed by the HR
`data.report_downloaded`	Boolean	This shows if the report was downloaded by the HR
`data.auto_recommendation`	String	This is the flag used to reject a candidate automatically based on the score
`data.suspicious_activity`	Object	Details of the Proctoring Summary
`data.suspicious_activity.status`	String	Proctoring Summary
`data.suspicious_activity.color_code`	Number	Color Code of the Proctoring Summary. Allowed Values: `1`,`2`,`3`
`total_candidates`	Number	Total Candidate count
`total_pages`	Number	Total available pages

200 OK
{
  "message": "Success",
  "data": [
    {
      "cand_id": "3bf496c2-9b35-43cc-af18-a711aaa45bde",
      "mobile_no": null,
      "name": "praveen",
      "email_id": "praveen+234232@loopreality.com",
      "reviewers": [],
      "status": "Ongoing",
      "status_reason": null,
      "assment_id": "846",
      "persp_score": null,
      "profile_score": null,
      "lic_key": "-",
      "end_date": "2023-06-08 04:30:59+00:00",
      "candidate_recommendation": null,
      "invited_on": "2023-06-01 10:15:36+00:00",
      "started_on": "2023-06-03 10:15:36+00:00",
      "completed_on": null,
      "completion_status": "Ongoing",
      "report_seen": false,
      "report_downloaded": false,
      "auto_recommendation": null,
      "suspicious_activity": {}
    },
    {
      "cand_id": "d5cb9bd6-64d5-421d-86e2-24df4e59686f",
      "mobile_no": null,
      "name": "Sai Tharun",
      "email_id": "paiscoreandproc2+1@loopreality.com",
      "reviewers": [],
      "status": "Complete",
      "status_reason": null,
      "assment_id": "846",
      "persp_score": 92,
      "profile_score": 55,
      "lic_key": "MTHXQF",
      "end_date": "2023-06-08 04:30:48+00:00",
      "candidate_recommendation": null,
      "invited_on": "2023-06-01 05:22:20+00:00",
      "started_on": "2023-05-29 10:15:36+00:00",
      "completed_on": "2023-06-01 05:42:57.499675+00:00",
      "completion_status": "Complete",
      "report_seen": false,
      "report_downloaded": false,
      "auto_recommendation": null,
      "suspicious_activity": {
        "status": "Not Detected",
        "color_code": 3
      }
    }
  ],
  "total_candidates": 2,
  "total_pages": 1
}

500 Internal Server Error
{
    "message":"Something went wrong"
}

candidate