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

# List Evaluations

Retrieve a paginated list of evaluations in your workspace.


## OpenAPI

````yaml GET /api/public/v2/evaluations
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers: []
security:
  - ApiKeyAuth: []
paths:
  /api/public/v2/evaluations:
    get:
      tags:
        - evaluations
      summary: List Evaluations
      operationId: listEvaluations
      parameters:
        - name: workspace_id
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: >-
            Filter by specific workspace ID. If not provided, uses the current
            user's workspace
        - name: name
          in: query
          required: false
          schema:
            type: string
          description: Filter evaluations by name (case-insensitive partial match)
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - deleted
              - all
            default: active
          description: >-
            Filter evaluations by status: 'active' (default) returns only active
            evaluations, 'deleted' returns only deleted/archived evaluations,
            'all' returns both
        - name: include_runs
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            If true, include batch runs nested under each evaluation. Each run
            includes its full report data, status (RUNNING or COMPLETED), and
            cell status counts.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number for pagination
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          description: Number of items per page
        - name: created_by_email
          in: query
          required: false
          schema:
            type: string
          description: Filter by the creator's email address.
        - name: created_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter resources created at or after this timestamp.
        - name: created_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter resources created at or before this timestamp.
        - name: updated_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter resources updated at or after this timestamp.
        - name: updated_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter resources updated at or before this timestamp.
        - name: external_source
          in: query
          required: false
          schema:
            type: string
          description: External ID source to filter by. Must be provided with external_id.
        - name: external_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            External ID value to filter by. Must be provided with
            external_source.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
            enum:
              - created_at
              - updated_at
              - name
              - id
          description: Sort field.
        - name: sort_order
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Sort direction.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  evaluations:
                    type: array
                    items:
                      $ref: '#/components/schemas/Evaluation'
                  page:
                    type: integer
                  per_page:
                    type: integer
                  total:
                    type: integer
                  pages:
                    type: integer
                required:
                  - success
                  - message
                  - evaluations
                  - page
                  - per_page
                  - total
                  - pages
        '400':
          description: Invalid workspace_id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    Evaluation:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the evaluation
        name:
          type: string
          description: Name of the evaluation
        comment:
          type: string
          nullable: true
          description: Optional comment or description for the evaluation
        created_at:
          type: string
          format: date-time
          description: Timestamp when the evaluation was created
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the evaluation was last updated
        workspace_id:
          type: integer
          description: ID of the workspace this evaluation belongs to
        folder_id:
          type: integer
          nullable: true
          description: ID of the folder containing this evaluation
        user_id:
          type: integer
          nullable: true
          description: ID of the user who created this evaluation
        dataset_id:
          type: integer
          nullable: true
          description: ID of the dataset associated with this evaluation
        is_blueprint:
          type: boolean
          description: Whether this is a blueprint (pipeline definition) or a batch run
        tags:
          type: object
          nullable: true
          description: Tags associated with this evaluation
        deleted:
          type: boolean
          description: Whether this evaluation has been deleted
        parent_report_id:
          type: integer
          nullable: true
          description: ID of the parent blueprint (set for batch runs)
        score_configuration:
          type: object
          nullable: true
          description: Custom scoring configuration for this evaluation
        runs:
          type: array
          description: Batch runs for this evaluation. Only present when include_runs=true.
          items:
            type: object
            properties:
              id:
                type: integer
                description: Unique identifier for the run
              name:
                type: string
                description: Name of the run
              comment:
                type: string
                nullable: true
                description: Optional comment or description
              created_at:
                type: string
                format: date-time
                description: Timestamp when the run was created
              updated_at:
                type: string
                format: date-time
                description: Timestamp when the run was last updated
              workspace_id:
                type: integer
                description: ID of the workspace
              folder_id:
                type: integer
                nullable: true
                description: ID of the folder
              user_id:
                type: integer
                nullable: true
                description: ID of the user who created this run
              dataset_id:
                type: integer
                nullable: true
                description: ID of the dataset
              is_blueprint:
                type: boolean
                description: Whether this is a blueprint
              tags:
                type: object
                nullable: true
                description: Tags associated with this run
              deleted:
                type: boolean
                description: Whether this run has been deleted
              parent_report_id:
                type: integer
                nullable: true
                description: ID of the parent blueprint
              score_configuration:
                type: object
                nullable: true
                description: Custom scoring configuration
              score:
                type: object
                nullable: true
                description: Computed score for this run
              score_matrix:
                type: array
                nullable: true
                description: Matrix of scores across evaluation columns
              score_calculation_error:
                type: string
                nullable: true
                description: Error message if score calculation failed
              status:
                type: string
                enum:
                  - RUNNING
                  - COMPLETED
                description: Current status of the batch run
              stats:
                type: object
                description: Run statistics
                properties:
                  status_counts:
                    type: object
                    description: Count of cells by status
        external_ids:
          type: array
          items:
            $ref: '#/components/schemas/ExternalId'
          description: External ID mappings attached to this evaluation.
      required:
        - id
        - name
        - workspace_id
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          default: false
          description: Indicates that the request failed.
        message:
          type: string
          description: Human-readable error message.
        error:
          type: string
          description: Machine-readable or fallback error message.
      additionalProperties: true
      description: >-
        Standard error response. Some legacy endpoints may return either message
        or error.
    ExternalId:
      properties:
        source:
          type: string
          maxLength: 128
          minLength: 1
          title: Source
          description: The external system or namespace that owns the ID.
        external_id:
          type: string
          maxLength: 512
          minLength: 1
          title: External Id
          description: The identifier for this entity in the external system.
      type: object
      required:
        - source
        - external_id
      additionalProperties: false
      title: ExternalId
      description: >-
        Customer-defined mapping between a PromptLayer entity and an external
        system identifier.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  responses:
    UnauthorizedError:
      description: Unauthorized - missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Validation error - request parameters or body are invalid.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/HTTPValidationError'
              - $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````