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

# Get Screens

> List screens for the authenticated organization. Results are paginated (default 100 per page, max 1000); use the page and pageSize query parameters to page through the full set, and read the returned pagination.totalPages to know when to stop.



## OpenAPI

````yaml https://api.ropes.ai/api/docs/openapi.json get /api/public/assessments
openapi: 3.0.0
info:
  title: Ropes Public API
  version: 1.0.0
  description: >-
    Public API for Ropes. Authenticate using your API key in the x-api-key
    header.
servers:
  - url: https://api.ropes.ai
    description: Production server
  - url: http://localhost:3001
    description: Local development server
security: []
paths:
  /api/public/assessments:
    get:
      tags:
        - Screens
      summary: Get Screens
      description: >-
        List screens for the authenticated organization. Results are paginated
        (default 100 per page, max 1000); use the page and pageSize query
        parameters to page through the full set, and read the returned
        pagination.totalPages to know when to stop.
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
            description: 'Page number (default: 1)'
          required: false
          description: 'Page number (default: 1)'
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 100
            description: 'Number of screens per page (default: 100, max: 1000)'
          required: false
          description: 'Number of screens per page (default: 100, max: 1000)'
          name: pageSize
          in: query
      responses:
        '200':
          description: Successfully retrieved screens
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentsResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: >-
            Rate limit exceeded - contact support@ropes.ai for further
            assistance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    AssessmentsResponse:
      type: object
      properties:
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/Assessment'
          description: List of screens for the current page
        pagination:
          $ref: '#/components/schemas/AssessmentsPagination'
      required:
        - assessments
        - pagination
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        message:
          type: string
          description: Error message (alternative field)
    Assessment:
      type: object
      properties:
        identifier:
          type: string
          description: Unique identifier for the screen
        candidateId:
          type: string
          description: Identifier of the candidate taking the screen
        problemId:
          type: string
          description: Identifier of the problem assigned to this screen
        problemType:
          $ref: '#/components/schemas/ProblemType'
        status:
          $ref: '#/components/schemas/AssessmentStatus'
        createdAt:
          type: string
          description: Timestamp when the screen was created
      required:
        - identifier
        - candidateId
        - problemId
        - problemType
        - status
        - createdAt
    AssessmentsPagination:
      type: object
      properties:
        page:
          type: number
          description: Current page number
        pageSize:
          type: number
          description: Number of screens per page
        totalItems:
          type: number
          description: Total number of screens matching the query
        totalPages:
          type: number
          description: Total number of pages
      required:
        - page
        - pageSize
        - totalItems
        - totalPages
      description: Pagination metadata
    ProblemType:
      type: string
      enum:
        - technical-assessment
        - video-screening
      description: Problem type discriminator
    AssessmentStatus:
      type: string
      enum:
        - Not Started
        - In Progress
        - Processing
        - Completed
        - Expired
        - Deleted
        - Error
      description: >-
        Current screen lifecycle status:

        - Not Started: Screen created and invite sent (or ready to send);
        candidate has not clicked Start.

        - In Progress: Candidate has started.

        - Processing: Candidate submitted (or was auto-submitted when time
        expired); results are being generated by Ropes.

        - Completed: Results are ready for review.

        - Expired: Screen expired before the candidate took it.

        - Deleted: Screen was deleted.

        - Error: Deprecated legacy status for screens that failed during result
        generation. New screens should not reach this status; existing rows may
        still return it.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````