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

# Get evaluators

> Get an evaluator by ID, name or fetch all evaluators for a workspace



## OpenAPI

````yaml /public-apis/openapi/evaluators.json get /v1/evaluators
openapi: 3.0.0
info:
  version: 1.0.0
  contact:
    name: Maxim Engineering
    email: eng@getmaxim.ai
  title: Maxim SDK API - evaluators
  description: API documentation for Maxim SDK evaluators endpoints
servers:
  - url: https://api.getmaxim.ai
security: []
paths:
  /v1/evaluators:
    get:
      tags:
        - Evaluator
      summary: Get evaluators
      description: Get an evaluator by ID, name or fetch all evaluators for a workspace
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Unique identifier for the workspace
          required: true
          name: workspaceId
          in: query
        - schema:
            type: string
            description: Unique identifier for the evaluator
          required: false
          name: id
          in: query
        - schema:
            type: number
            nullable: true
            default: 10
            description: Maximum number of records to return. 10 by default
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: Name of the evaluator
          required: false
          name: name
          in: query
        - schema:
            type: string
            description: Cursor for pagination
          required: false
          name: cursor
          in: query
      responses:
        '200':
          description: Evaluators retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          description:
                            type: string
                          type:
                            type: string
                          config:
                            type: object
                            properties:
                              model:
                                type: string
                              provider:
                                type: string
                              variables:
                                type: object
                                additionalProperties:
                                  nullable: true
                              gradingStyle:
                                type: string
                              passFailCriteria:
                                type: object
                                properties:
                                  runLevel:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      value:
                                        type: number
                                      operator:
                                        type: string
                                    required:
                                      - name
                                      - value
                                      - operator
                                  entryLevel:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      value:
                                        type: string
                                      operator:
                                        type: string
                                    required:
                                      - name
                                      - value
                                      - operator
                                required:
                                  - runLevel
                                  - entryLevel
                            required:
                              - model
                              - provider
                              - gradingStyle
                              - passFailCriteria
                          accountId:
                            type: string
                          workspaceId:
                            type: string
                          builtin:
                            type: boolean
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                          deletedAt:
                            type: string
                          tags:
                            type: array
                            items:
                              type: object
                              properties:
                                label:
                                  type: string
                                value:
                                  type: string
                              required:
                                - label
                                - value
                        required:
                          - id
                          - name
                          - description
                          - type
                          - config
                          - accountId
                          - workspaceId
                          - builtin
                          - createdAt
                          - updatedAt
                          - deletedAt
                      - type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            description:
                              type: string
                            type:
                              type: string
                            config:
                              type: object
                              properties:
                                model:
                                  type: string
                                provider:
                                  type: string
                                variables:
                                  type: object
                                  additionalProperties:
                                    nullable: true
                                gradingStyle:
                                  type: string
                                passFailCriteria:
                                  type: object
                                  properties:
                                    runLevel:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                        value:
                                          type: number
                                        operator:
                                          type: string
                                      required:
                                        - name
                                        - value
                                        - operator
                                    entryLevel:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                        value:
                                          type: string
                                        operator:
                                          type: string
                                      required:
                                        - name
                                        - value
                                        - operator
                                  required:
                                    - runLevel
                                    - entryLevel
                              required:
                                - model
                                - provider
                                - gradingStyle
                                - passFailCriteria
                            accountId:
                              type: string
                            workspaceId:
                              type: string
                            builtin:
                              type: boolean
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                            deletedAt:
                              type: string
                            tags:
                              type: array
                              items:
                                type: object
                                properties:
                                  label:
                                    type: string
                                  value:
                                    type: string
                                required:
                                  - label
                                  - value
                          required:
                            - id
                            - name
                            - description
                            - type
                            - config
                            - accountId
                            - workspaceId
                            - builtin
                            - createdAt
                            - updatedAt
                            - deletedAt
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: string
                        nullable: true
                      hasMore:
                        type: boolean
                    required:
                      - cursor
                      - hasMore
                required:
                  - data
        '400':
          description: Invalid request parameters
        '404':
          description: Evaluator not found
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-maxim-api-key
      description: API key for authentication

````