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

# List course evaluation periods



## OpenAPI

````yaml /openapi.json get /api/v1/course_evaluation_periods
openapi: 3.1.0
info:
  title: Scholarly API V1
  version: v1
  description: API for accessing Scholarly data
  license:
    name: Proprietary
    identifier: Proprietary
servers:
  - url: https://api.scholarlysoftware.com
    description: Production server
security: []
paths:
  /api/v1/course_evaluation_periods:
    get:
      tags:
        - Course Evaluation Periods
      summary: List course evaluation periods
      operationId: listCourseEvaluationPeriods
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token
          schema:
            type: string
        - name: include
          in: query
          required: false
          description: >-
            Comma-separated list of relationships to include. Allowed: `term`,
            `schedule`, `evaluations`, `question_sets`, `courses`
          schema:
            type: string
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. Prefix with `-` for descending. Allowed: `created_at`,
            `updated_at`, `name`
          schema:
            type: string
        - name: filter[key]
          in: query
          required: false
          description: >-
            Filter results. Available filters: `created_at`, `created_at.neq`,
            `created_at.lt`, `created_at.lte`, `created_at.gt`,
            `created_at.gte`, `updated_at`, `updated_at.neq`, `updated_at.lt`,
            `updated_at.lte`, `updated_at.gt`, `updated_at.gte`, `name`,
            `name.neq`, `name.cont` (case-insensitive substring match),
            `name.in` (list of values, comma-separated), `name.nin` (list of
            values, comma-separated), `evaluation_type`, `evaluation_type.neq`,
            `evaluation_type.in` (list of values, comma-separated),
            `evaluation_type.nin` (list of values, comma-separated), `kind`,
            `kind.neq`, `kind.in` (list of values, comma-separated), `kind.nin`
            (list of values, comma-separated), `draft` (boolean), `term`,
            `schedule`, `schedule.exists` (boolean), `evaluations`,
            `question_sets`, `courses`.
          schema:
            type: string
        - name: page[size]
          in: query
          required: false
          description: Number of items per page (max 100)
          schema:
            type: integer
        - name: page[after]
          in: query
          required: false
          description: Cursor for next page
          schema:
            type: string
        - name: page[before]
          in: query
          required: false
          description: Cursor for previous page
          schema:
            type: string
      responses:
        '200':
          description: course evaluation periods found
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CourseEvaluationPeriod'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
                  links:
                    $ref: '#/components/schemas/PaginationLinks'
                required:
                  - data
        '401':
          description: unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer_auth: []
components:
  schemas:
    CourseEvaluationPeriod:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          const: course_evaluation_period
          example: course_evaluation_period
        attributes:
          type: object
          properties:
            created_at:
              type: string
              format: datetime
            updated_at:
              type: string
              format: datetime
            name:
              type: string
              example: Fall 2026 Course Evaluations
            evaluation_type:
              type: string
              enum:
                - end_of_term
                - midterm
                - custom
            kind:
              type: string
              enum:
                - section
                - instructor
            draft:
              type: boolean
            status:
              type: string
              enum:
                - draft
                - scheduled
                - open
                - closed
                - released
              description: Computed from draft, the schedule, and results_release_at
            results_release_at:
              type:
                - string
                - 'null'
              format: datetime
              description: >-
                When each evaluation's results release. An evaluation may
                override it. A blank date never releases results.
            minimum_response_threshold:
              type:
                - integer
                - 'null'
              description: >-
                Each evaluation's results stay hidden until it has this many
                completed responses. An evaluation may override it. A blank
                threshold never releases results.
            flag_answers_at_or_below:
              type:
                - integer
                - 'null'
              description: >-
                Results flag a scale question when any answer is at or below
                this value. An evaluation may override it. A blank value turns
                the rule off.
            flag_standard_deviation_above:
              type:
                - number
                - 'null'
              description: >-
                Results flag a scale question when its standard deviation
                exceeds this value. An evaluation may override it. A blank value
                turns the rule off.
            results_visible_to_roles:
              type: array
              items:
                type: string
                enum:
                  - instructor
                  - department_admin
            results_guidelines:
              type:
                - string
                - 'null'
              description: >-
                Rich text (minimal HTML) shown above the results of every
                evaluation in the period, on the page and in the PDFs
            course_uuids:
              type: array
              description: >-
                UUIDs of the covered course_evaluation_courses. Writing replaces
                the set: an evaluation is added for every section of an added
                course in the period's term, and removing a course destroys its
                evaluations and their responses.
              items:
                type: string
                format: uuid
        relationships:
          type: object
          properties:
            term:
              type: object
              properties:
                links:
                  type: object
                  properties:
                    related:
                      type: string
                      format: uri
                  required:
                    - related
                meta:
                  type: object
                data:
                  type: object
                  required:
                    - type
                    - id
                  properties:
                    type:
                      type: string
                      const: course_evaluation_term
                      example: course_evaluation_term
                    id:
                      type: string
                      format: uuid
              anyOf:
                - required:
                    - links
                - required:
                    - meta
                - required:
                    - data
            schedule:
              type: object
              properties:
                links:
                  type: object
                  properties:
                    related:
                      type:
                        - string
                        - 'null'
                      format: uri
                  required:
                    - related
                meta:
                  type: object
                data:
                  oneOf:
                    - type: object
                      required:
                        - type
                        - id
                      properties:
                        type:
                          type: string
                          const: course_evaluation_period_schedule
                          example: course_evaluation_period_schedule
                        id:
                          type: string
                          format: uuid
                    - type: 'null'
              anyOf:
                - required:
                    - links
                - required:
                    - meta
                - required:
                    - data
            evaluations:
              type: object
              properties:
                links:
                  type: object
                  properties:
                    related:
                      type:
                        - string
                        - 'null'
                      format: uri
                  required:
                    - related
                meta:
                  type: object
                data:
                  type: array
                  items:
                    type: object
                    required:
                      - type
                      - id
                    properties:
                      type:
                        type: string
                        const: course_evaluation
                        example: course_evaluation
                      id:
                        type: string
                        format: uuid
              anyOf:
                - required:
                    - links
                - required:
                    - meta
                - required:
                    - data
            question_sets:
              type: object
              properties:
                links:
                  type: object
                  properties:
                    related:
                      type:
                        - string
                        - 'null'
                      format: uri
                  required:
                    - related
                meta:
                  type: object
                data:
                  type: array
                  items:
                    type: object
                    required:
                      - type
                      - id
                    properties:
                      type:
                        type: string
                        const: course_evaluation_question_set
                        example: course_evaluation_question_set
                      id:
                        type: string
                        format: uuid
                  description: Ordered as presented to students
              anyOf:
                - required:
                    - links
                - required:
                    - meta
                - required:
                    - data
            courses:
              type: object
              properties:
                links:
                  type: object
                  properties:
                    related:
                      type:
                        - string
                        - 'null'
                      format: uri
                  required:
                    - related
                meta:
                  type: object
                data:
                  type: array
                  items:
                    type: object
                    required:
                      - type
                      - id
                    properties:
                      type:
                        type: string
                        const: course_evaluation_course
                        example: course_evaluation_course
                      id:
                        type: string
                        format: uuid
                  description: The courses covered by the period's evaluations
              anyOf:
                - required:
                    - links
                - required:
                    - meta
                - required:
                    - data
      required:
        - id
        - type
        - attributes
    PaginationMeta:
      type: object
      properties:
        page:
          type: object
          properties:
            size:
              type: integer
        total:
          type: integer
    PaginationLinks:
      type: object
      properties:
        self:
          type: string
        first:
          type: string
        next:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
              title:
                type: string
              detail:
                type: string
            required:
              - status
              - title
      required:
        - errors
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.