## List Evaluation Groups

**get** `/v5/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.

### Query Parameters

- `ending_before: optional string`

- `evaluation_id: optional string`

  Filter to groups containing this evaluation ID

- `include_deleted: optional boolean`

- `limit: optional number`

- `name: optional string`

- `sort_by: optional string`

- `sort_order: optional SortOrder`

  - `"asc"`

  - `"desc"`

- `starting_after: optional string`

- `tags: optional array of string`

- `views: optional array of EvaluationGroupViews`

  Optional relationships to include: 'members', 'row_identifiers'

  - `"members"`

  - `"row_identifiers"`

### Returns

- `has_more: boolean`

  Whether there are more items left to be fetched.

- `items: array of EvaluationGroup`

  - `id: string`

    Unique identifier of the evaluation group

  - `account_id: string`

    Account that owns this evaluation group

  - `created_at: string`

    When the group was created

  - `name: string`

    Name of the evaluation group

  - `tags: array of string`

    The tags associated with the entity

  - `deleted_at: optional string`

    When the group was soft-deleted

  - `description: optional string`

    Optional description

  - `members: optional array of EvaluationGroupMember`

    Evaluation members in this group. Returned by default on GET by id; on list endpoints, populated only with the 'members' view.

    - `id: string`

      Unique identifier of the member record

    - `created_at: string`

      When this member was added to the group

    - `evaluation_group_id: string`

      ID of the evaluation group

    - `evaluation_id: string`

      ID of the evaluation

    - `deleted_at: optional string`

      When this membership was soft-deleted (if applicable)

    - `evaluation_created_at: optional string`

      When the evaluation was created

    - `evaluation_name: optional string`

      Name of the evaluation

    - `evaluation_tags: optional array of string`

      Tags of the evaluation

    - `object: optional "evaluation_group.member"`

      - `"evaluation_group.member"`

  - `metadata: optional map[unknown]`

    Optional metadata key-value pairs

  - `object: optional "evaluation_group"`

    - `"evaluation_group"`

  - `row_identifiers: optional array of EvaluationGroupRowIdentifier`

    Row identifier mappings. Populated with 'row_identifiers' view.

    - `column_name: string`

      Name of the column used as row identifier

    - `evaluation_id: string`

      ID of the evaluation

    - `object: optional "evaluation_group.row_identifier"`

      - `"evaluation_group.row_identifier"`

- `total: number`

  The total of items that match the query. This is greater than or equal to the number of items returned.

- `limit: optional number`

  The maximum number of items to return.

- `object: optional "list"`

  - `"list"`

### Example

```http
curl https://api.egp.scale.com/v5/evaluation-groups \
    -H "x-api-key: $SGP_API_KEY"
```

#### Response

```json
{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "tags": [
        "string"
      ],
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "members": [
        {
          "id": "id",
          "created_at": "2019-12-27T18:11:19.117Z",
          "evaluation_group_id": "evaluation_group_id",
          "evaluation_id": "evaluation_id",
          "deleted_at": "2019-12-27T18:11:19.117Z",
          "evaluation_created_at": "2019-12-27T18:11:19.117Z",
          "evaluation_name": "evaluation_name",
          "evaluation_tags": [
            "string"
          ],
          "object": "evaluation_group.member"
        }
      ],
      "metadata": {
        "foo": "bar"
      },
      "object": "evaluation_group",
      "row_identifiers": [
        {
          "column_name": "column_name",
          "evaluation_id": "evaluation_id",
          "object": "evaluation_group.row_identifier"
        }
      ]
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}
```