## List Evaluation Groups

`client.EvaluationGroups.List(ctx, query) (*CursorPage[EvaluationGroup], error)`

**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.

### Parameters

- `query EvaluationGroupListParams`

  - `EndingBefore param.Field[string]`

  - `EvaluationID param.Field[string]`

    Filter to groups containing this evaluation ID

  - `IncludeDeleted param.Field[bool]`

  - `Limit param.Field[int64]`

  - `Name param.Field[string]`

  - `SortBy param.Field[string]`

  - `SortOrder param.Field[SortOrder]`

  - `StartingAfter param.Field[string]`

  - `Tags param.Field[[]string]`

  - `Views param.Field[[]EvaluationGroupViews]`

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

    - `const EvaluationGroupViewsMembers EvaluationGroupViews = "members"`

    - `const EvaluationGroupViewsRowIdentifiers EvaluationGroupViews = "row_identifiers"`

### Returns

- `type EvaluationGroup struct{…}`

  Response model for evaluation group

  - `ID string`

    Unique identifier of the evaluation group

  - `AccountID string`

    Account that owns this evaluation group

  - `CreatedAt Time`

    When the group was created

  - `Name string`

    Name of the evaluation group

  - `Tags []string`

    The tags associated with the entity

  - `DeletedAt Time`

    When the group was soft-deleted

  - `Description string`

    Optional description

  - `Members []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

    - `CreatedAt Time`

      When this member was added to the group

    - `EvaluationGroupID string`

      ID of the evaluation group

    - `EvaluationID string`

      ID of the evaluation

    - `DeletedAt Time`

      When this membership was soft-deleted (if applicable)

    - `EvaluationCreatedAt Time`

      When the evaluation was created

    - `EvaluationName string`

      Name of the evaluation

    - `EvaluationTags []string`

      Tags of the evaluation

    - `Object EvaluationGroupMemberObject`

      - `const EvaluationGroupMemberObjectEvaluationGroupMember EvaluationGroupMemberObject = "evaluation_group.member"`

  - `Metadata map[string, any]`

    Optional metadata key-value pairs

  - `Object EvaluationGroupObject`

    - `const EvaluationGroupObjectEvaluationGroup EvaluationGroupObject = "evaluation_group"`

  - `RowIdentifiers []EvaluationGroupRowIdentifier`

    Row identifier mappings. Populated with 'row_identifiers' view.

    - `ColumnName string`

      Name of the column used as row identifier

    - `EvaluationID string`

      ID of the evaluation

    - `Object EvaluationGroupRowIdentifierObject`

      - `const EvaluationGroupRowIdentifierObjectEvaluationGroupRowIdentifier EvaluationGroupRowIdentifierObject = "evaluation_group.row_identifier"`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  page, err := client.EvaluationGroups.List(context.TODO(), sgpdev.EvaluationGroupListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### 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"
}
```