# List Assessments

GET $BASE_URL/portal/get_assessments?limit={$limit}&page={$page}&status={$status}

# Request Payload

Field	Type	Description
`limit`	Number	Number of Assessments details per call
`page`	Number	Page Number for Assessments details
`status` Optional	String	Current Status of Assessment Filter `Active`, `Pause`

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

# Response Payload

Field	Type	Description
`message`	String	Message
`assessment_list`	List[Object]	List of assessments details
`assessment_list.completion_Status`	Object	List of completion stats
`assessment_list.assessment_name`	String	Name of the Assessment
`assessment_list.assessment_code`	String	Assessment Code. This is a part of assessment ID.
`assessment_list.module_count`	Number	Number of modules present in this assessment
`assessment_list.level`	String	Level of the assessment selected by the HR
`assessment_list.duration`	String	Duration of the assessment
`assessment_list.department`	String	Department of the assessment configured by the HR
`assessment_list.seniority`	String	Seniority of the assessment configured by the HR
`assessment_list.status`	String	Status of the Assessment (Active/Paused)
`assessment_list.invitees_status`	Boolean	Flag to enable/disable the editing of the assessment based on the candidates invited
`assessment_list.mul_langs`	Boolean	If multi lingual is enabled in the assessment
`assessment_list.bu_id`	String	Business Unit ID
`assessment_list.bu_name`	Object	Name of the BU
`assessment_list.created_on`	String	Date on which the assessment is created
`assessment_list.id`	String	Unique ID of the Assessment
`total_assessments`	Number	Total Assessments available
`total_pages`	Number	Total available pages

200 OK
{
  "message": "Success",
  "assessment_list": [
    {
      "completion_Status": {
        "Expired": 12,
        "Completed": 6,
        "Total": 18,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "Aditya Birla Multilanguage Demo",
      "assessment_code": "104",
      "module_count": 4,
      "level": null,
      "duration": "00:23:00",
      "department": "Sales",
      "seniority": "Fresher",
      "status": "Pause",
      "invitees_status": true,
      "mul_langs": true,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "None",
      "id": "91a107a6-256f-4289-bdcf-9599df69a126"
    },
    {
      "assessment_name": "Sample Assessment",
      "assessment_code": "850",
      "module_count": 5,
      "level": null,
      "duration": "00:24:49",
      "department": "Sales",
      "seniority": "Fresher",
      "status": "Active",
      "invitees_status": false,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-06-02 20:35:41.120127+00:00",
      "id": "55a2c962-5dfc-4844-a7cc-1d880554df00",
      "completion_Status": {
        "Expired": 0,
        "Completed": 0,
        "Total": 0,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      }
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 1,
        "Total": 1,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "All Dimension with proc & without Typing",
      "assessment_code": "849",
      "module_count": 6,
      "level": null,
      "duration": "00:39:15",
      "department": "Technology",
      "seniority": "Senior Level",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-06-01 06:30:32.896966+00:00",
      "id": "f29862b4-6846-424e-bec4-e8b8e370b419"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 1,
        "Total": 2,
        "Ongoing": 1,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "Typing test",
      "assessment_code": "848",
      "module_count": 1,
      "level": null,
      "duration": "00:06:00",
      "department": "Sales",
      "seniority": "Fresher",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-06-01 06:21:00.155008+00:00",
      "id": "6beb4b8e-5455-4a45-bf0f-3c52a9367aec"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 1,
        "Total": 1,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "PAI score with out proc & Typing",
      "assessment_code": "847",
      "module_count": 6,
      "level": null,
      "duration": "00:39:15",
      "department": "Technology",
      "seniority": "Senior Level",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-06-01 06:04:14.204463+00:00",
      "id": "6acbd6a1-e021-4dfb-b2f6-0c07fe5ecbe3"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 1,
        "Total": 2,
        "Ongoing": 1,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "PAI scoring and proctoring 2",
      "assessment_code": "846",
      "module_count": 6,
      "level": null,
      "duration": "00:57:15",
      "department": "Technology",
      "seniority": "Senior Level",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-06-01 05:21:27.509347+00:00",
      "id": "0f324098-732b-46d9-bf77-8012365247fc"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 2,
        "Total": 3,
        "Ongoing": 1,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "Automation report",
      "assessment_code": "845",
      "module_count": 12,
      "level": null,
      "duration": "01:14:15",
      "department": "Technology",
      "seniority": "Senior Level",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-31 15:38:46.410637+00:00",
      "id": "7d2aaf32-2172-420e-82d3-134d9659d7b3"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 6,
        "Total": 7,
        "Ongoing": 1,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "Final 2",
      "assessment_code": "844",
      "module_count": 4,
      "level": null,
      "duration": "00:22:00",
      "department": "Marketing",
      "seniority": "Team Leader",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-31 14:54:13.267758+00:00",
      "id": "55995107-3481-465f-affd-b0e27dbf4530"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 1,
        "Total": 1,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "Final Score",
      "assessment_code": "843",
      "module_count": 4,
      "level": null,
      "duration": "00:22:00",
      "department": "Marketing",
      "seniority": "Mid Level",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-31 14:45:47.968133+00:00",
      "id": "daa54923-7afc-4b43-83f9-2de72079ccec"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 0,
        "Total": 2,
        "Ongoing": 2,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "PAI Score without proc",
      "assessment_code": "842",
      "module_count": 8,
      "level": null,
      "duration": "01:19:45",
      "department": "Production",
      "seniority": "Team Leader",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-31 14:16:10.420883+00:00",
      "id": "11697440-328c-4f11-9602-e6938cea951b"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 3,
        "Total": 4,
        "Ongoing": 1,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "PAI score and proctoring",
      "assessment_code": "841",
      "module_count": 8,
      "level": null,
      "duration": "01:19:45",
      "department": "Marketing",
      "seniority": "Team Leader",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-31 11:30:38.792655+00:00",
      "id": "a96512b9-bb78-495b-9592-47d41a9d5e41"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 0,
        "Total": 1,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 1,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "optional 3",
      "assessment_code": "840",
      "module_count": 1,
      "level": null,
      "duration": "00:04:00",
      "department": "Sales",
      "seniority": "Fresher",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-30 12:07:09.144271+00:00",
      "id": "0bd87deb-f5a1-4155-95b6-55f45785f81c"
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 0,
        "Total": 1,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 1,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "Optional 2",
      "assessment_code": "839",
      "module_count": 1,
      "level": null,
      "duration": "00:04:00",
      "department": "Sales",
      "seniority": "Fresher",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-30 12:05:27.866701+00:00",
      "id": "676a37d8-6149-4dd5-9f81-04a4b6178617"
    },
    {
      "assessment_name": "Optional 1",
      "assessment_code": "838",
      "module_count": 1,
      "level": null,
      "duration": "00:04:00",
      "department": "Sales",
      "seniority": "Team Leader",
      "status": "Active",
      "invitees_status": false,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-30 09:24:45.690431+00:00",
      "id": "bf419773-f31e-4bc3-a836-a6c86074ee53",
      "completion_Status": {
        "Expired": 0,
        "Completed": 0,
        "Total": 0,
        "Ongoing": 0,
        "YetToRegister": 0,
        "Registered": 0,
        "Incomplete": 0,
        "Pending": 0
      }
    },
    {
      "completion_Status": {
        "Expired": 0,
        "Completed": 0,
        "Total": 5,
        "Ongoing": 3,
        "YetToRegister": 0,
        "Registered": 2,
        "Incomplete": 0,
        "Pending": 0
      },
      "assessment_name": "Hello optional",
      "assessment_code": "837",
      "module_count": 1,
      "level": null,
      "duration": "00:04:00",
      "department": "Sales",
      "seniority": "Team Leader",
      "status": "Active",
      "invitees_status": true,
      "mul_langs": false,
      "bu_id": "4bff8b9d-6692-4e5d-8aae-ee50b342b56f",
      "bu_name": "Human Resource",
      "created_on": "2023-05-30 07:15:49.042991+00:00",
      "id": "3b65b71b-8919-4e45-99f2-da560bd3f203"
    }
  ],
  "total_assessments": 767,
  "total_pages": 52
}

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

assessments