> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crazygoldfish.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET - List Exam

> The GET /evaluation-platform/v1/exam API retrieves a paginated list of exams, providing detailed information about each exam, including associated documents, grades, subjects, and other metadata. 

**Scenarios:**
1. **Displaying Exams on an Admin Dashboard:** Admins can use this API to fetch and display a list of exams with relevant details for monitoring and management. 
2. **Filtering Exams by Grade or Subject:** Teachers can retrieve exams filtered by specific criteria like grade or subject to streamline their workflow. 
3. **Exam Status Monitoring:** Coordinators can use this API to track the status of exams (e.g., in progress, completed) and act accordingly. 
4. **Populating a Student Portal:** Students can view available exams based on their class and subject by leveraging the data retrieved from this API.

<div
  style={{
background: 'linear-gradient(135deg, #667eea 0%, #764ba2 100%)',
borderRadius: '16px',
padding: '4px',
marginTop: '20px',
marginBottom: '20px',
boxShadow: '0 10px 40px rgba(102, 126, 234, 0.3)'
}}
>
  <iframe
    className="w-full aspect-video rounded-xl"
    src="https://www.youtube.com/embed/o1hHLtI3x4s"
    title="Evaluation Platform | PATCH | GET | API Reference Guide"
    frameBorder="0"
    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
    allowFullScreen
    style={{
  borderRadius: '12px',
  boxShadow: '0 4px 6px rgba(0, 0, 0, 0.1)'
}}
  />
</div>


## OpenAPI

````yaml GET /evaluation-platform/v1/exam/
openapi: 3.0.1
info:
  title: Evaluation Report API
  description: An API for retrieving evaluation reports.
  version: 1.0.0
servers:
  - url: https://api-staging.crazygoldfish.com
    description: SandBox endpoint
  - url: https://api.crazygoldfish.com
    description: Prod End Point
security: []
paths:
  /evaluation-platform/v1/exam/:
    get:
      summary: Retrieve Exams
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    example: 78
                    description: Total number of exams available.
                  pageSize:
                    type: integer
                    example: 10
                    description: Number of items displayed per page.
                  showing:
                    type: string
                    example: Page 1 of 8
                    description: Current page display information.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    example: '{{base_url}}/evaluation-platform/v1/exam/?page=2'
                    description: URL for the next page of results.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    example: null
                    description: URL for the previous page of results.
                  data:
                    type: array
                    description: List of exams.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          example: 4340132f-50fa-4877-9ffa-e9b7ee59d51f
                          description: Unique identifier of the exam.
                        examName:
                          type: string
                          description: Name of the exam.
                          example: CBSE 10 – Mock Test
                        overallDuration:
                          type: string
                          example: '180'
                          nullable: true
                          description: Duration of the exam in minutes.
                        grade:
                          type: integer
                          example: 10
                          description: Grade level of the exam.
                        classSection:
                          type: string
                          nullable: true
                          example: null
                          description: Class section if applicable.
                        subject:
                          type: integer
                          example: 1
                          description: Subject ID associated with the exam.
                        examType:
                          type: integer
                          example: 1
                          description: Type of exam.
                        examSet:
                          type: string
                          example: N/A
                          description: Exam set details.
                        documents:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                                example: 18eb7110-d280-451d-8437-e54fe5f12dac
                                description: Unique identifier of the document.
                              status:
                                type: integer
                                example: 2
                                description: Status of the document.
                              pageNo:
                                type: integer
                                nullable: true
                                example: null
                                description: Page number if applicable.
                              uploadTime:
                                type: string
                                format: date-time
                                example: '2025-01-04T13:46:59.825883Z'
                                description: Time when the document was uploaded.
                              url:
                                type: string
                                format: uri
                                example: >-
                                  https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Science_-_Mock_Test.pdf.pdf
                                description: URL to access the document.
                              fileType:
                                type: integer
                                example: 1
                                description: Type of the file uploaded.
                          description: List of associated documents.
                        createdAt:
                          type: string
                          format: date-time
                          example: '2025-01-04T13:45:57.743446Z'
                          description: Timestamp when the exam was created.
                        modifiedAt:
                          type: string
                          format: date-time
                          example: '2025-01-04T13:54:29.506106Z'
                          description: Timestamp when the exam was last modified.
                        examDate:
                          type: string
                          format: date
                          example: '2024-01-09'
                          description: Date on which the exam is scheduled.
                        isFinalPublish:
                          type: boolean
                          example: false
                          description: Indicates if the exam is published as final.
                        isProvisionalPublished:
                          type: boolean
                          example: false
                          description: Indicates if the exam is published provisionally.
        '403':
          description: Authentication failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Token has expired
              example:
                detail: Token has expired
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````