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

# List Evaluation Groups

> List the calling account's evaluation groups with optional filters.

Results are paginated and scoped to the authenticated account. The optional filters
combine with AND semantics: name does a case-insensitive partial (substring) match on
the group name, tags returns only groups whose tag list contains all of the supplied
tags, and evaluation_id returns only groups that have the given evaluation as an
active member. By default archived (soft-deleted) groups are excluded; set
include_deleted to include them. The views parameter optionally expands each group
with its members and/or row_identifiers, and returned members are enriched with each
evaluation's name, tags, and creation time.



## OpenAPI

````yaml https://api.dev-sgp.scale.com/openapi-versions/v5/openapi.json get /v5/evaluation-groups
openapi: 3.1.0
info:
  title: EGP API V5
  description: >-
    This is the parent API for all EGP APIs. If you are looking for the EGP API,
    please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
  - url: https://api.egp.scale.com
security: []
paths:
  /v5/evaluation-groups:
    get:
      tags:
        - Evaluation Groups
      summary: List Evaluation Groups
      description: >-
        List the calling account's evaluation groups with optional filters.


        Results are paginated and scoped to the authenticated account. The
        optional filters

        combine with AND semantics: name does a case-insensitive partial
        (substring) match on

        the group name, tags returns only groups whose tag list contains all of
        the supplied

        tags, and evaluation_id returns only groups that have the given
        evaluation as an

        active member. By default archived (soft-deleted) groups are excluded;
        set

        include_deleted to include them. The views parameter optionally expands
        each group

        with its members and/or row_identifiers, and returned members are
        enriched with each

        evaluation's name, tags, and creation time.
      operationId: GET-V5-/v5/evaluation-groups
      parameters:
        - name: include_deleted
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include Deleted
        - name: tags
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            title: Tags
        - name: name
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Name
        - name: evaluation_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter to groups containing this evaluation ID
            title: Evaluation Id
          description: Filter to groups containing this evaluation ID
        - name: views
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/EvaluationGroupViews'
            description: 'Optional relationships to include: ''members'', ''row_identifiers'''
            default: []
            title: Views
          description: 'Optional relationships to include: ''members'', ''row_identifiers'''
        - name: starting_after
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Starting After
        - name: ending_before
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Ending Before
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 10000
            minimum: 1
            default: 100
            title: Limit
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Sort By
        - name: sort_order
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/SortOrder'
              - type: 'null'
            default: asc
            title: Sort Order
        - name: x-selected-account-id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedList_EvaluationGroup_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    EvaluationGroupViews:
      type: string
      enum:
        - members
        - row_identifiers
      title: EvaluationGroupViews
      description: Views for evaluation group responses
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    PaginatedList_EvaluationGroup_:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        items:
          items:
            $ref: '#/components/schemas/EvaluationGroup'
          type: array
          title: Items
        limit:
          type: integer
          title: Limit
          description: The maximum number of items to return.
          default: 100
        total:
          type: integer
          title: Total
          description: >-
            The total of items that match the query. This is greater than or
            equal to the number of items returned.
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more items left to be fetched.
      type: object
      required:
        - items
        - total
        - has_more
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EvaluationGroup:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the evaluation group
        object:
          type: string
          const: evaluation_group
          title: Object
          default: evaluation_group
        tags:
          title: Tags
          description: The tags associated with the entity
          items:
            type: string
          type: array
        name:
          type: string
          title: Name
          description: Name of the evaluation group
        description:
          title: Description
          description: Optional description
          type: string
        metadata:
          title: Metadata
          description: Optional metadata key-value pairs
          additionalProperties: true
          type: object
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the group was created
        deleted_at:
          title: Deleted At
          description: When the group was soft-deleted
          type: string
          format: date-time
        account_id:
          type: string
          title: Account Id
          description: Account that owns this evaluation group
        members:
          title: Members
          description: Evaluation members in this group. Populated with 'members' view.
          items:
            $ref: '#/components/schemas/EvaluationGroupMember'
          type: array
        row_identifiers:
          title: Row Identifiers
          description: Row identifier mappings. Populated with 'row_identifiers' view.
          items:
            $ref: '#/components/schemas/EvaluationGroupRowIdentifier'
          type: array
      type: object
      required:
        - tags
        - id
        - name
        - created_at
        - account_id
      description: Response model for evaluation group
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          title: Error Type
          type: string
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    EvaluationGroupMember:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the member record
        object:
          type: string
          const: evaluation_group.member
          title: Object
          default: evaluation_group.member
        evaluation_group_id:
          type: string
          title: Evaluation Group Id
          description: ID of the evaluation group
        evaluation_id:
          type: string
          title: Evaluation Id
          description: ID of the evaluation
        evaluation_name:
          title: Evaluation Name
          description: Name of the evaluation
          type: string
        evaluation_tags:
          title: Evaluation Tags
          description: Tags of the evaluation
          items:
            type: string
          type: array
        evaluation_created_at:
          title: Evaluation Created At
          description: When the evaluation was created
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When this member was added to the group
        deleted_at:
          title: Deleted At
          description: When this membership was soft-deleted (if applicable)
          type: string
          format: date-time
      type: object
      required:
        - id
        - evaluation_group_id
        - evaluation_id
        - created_at
      description: Response model for evaluation group member
    EvaluationGroupRowIdentifier:
      properties:
        object:
          type: string
          const: evaluation_group.row_identifier
          title: Object
          default: evaluation_group.row_identifier
        evaluation_id:
          type: string
          title: Evaluation Id
          description: ID of the evaluation
        column_name:
          type: string
          title: Column Name
          description: Name of the column used as row identifier
      type: object
      required:
        - evaluation_id
        - column_name
      description: Response model for evaluation group row identifier
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````