---
title: "List Scorecards"
method: GET
path: "/api/v1/scorecards"
tags: ["Scorecards"]
---

# List Scorecards

`GET /api/v1/scorecards`

Returns scorecards matching optional search criteria. If search criteria is specified we will use search logic, which will not find Scorecards that have yet to be evaluated

## Query parameters

- `showDrafts` boolean
- `groups` string[]
- `entities` string[]
- `teams` string[]
- `page` integer, required
- `pageSize` integer, required

## Response `200`

OK

- PaginatedScorecardsResponse
  - `page` integer, required — Current page number, 0-indexed
  - `scorecards` ScorecardResponse[], required
    - `dateCreated` string, date-time, required — Time the Scorecard was created
    - `description` string — Human-readable description of the Scorecard
    - `evaluation` EvaluationDetails — Evaluation window for how often the Scorecard is run
      - `window` integer — Number of hours between Scorecard evaluations. If the evaluation window is not set, the Scorecard is evaluated every 4 hours
    - `exemptions` ExemptionsSettings, required — Exemptions settings for the Scorecard
      - `autoApprove` boolean, required — This will enable auto-approving of Scorecard rule exemptions. If not set, it defaults to false.
      - `enabled` boolean, required — This will enable Scorecard rule exemptions. If not set, it defaults to true.
    - `filter` Filter — Filter applied to the Initiative
      - `groups` GroupFilter — Entity groups to include or exclude
        - `exclude` string[]
        - `include` string[]
      - `query` string — CQL expression to apply as a filter
      - `types` TypeFilter — Entity types (e.g. service, domain, team) to include or exclude. Only one of `include` or `exclude` can be set
        - `exclude` string[]
        - `include` string[]
    - `isDraft` boolean, required — Whether or not the Scorecard is in draft
    - `lastUpdated` string, date-time, required — Time the Scorecard was last updated, which includes setting the next evaluation time
    - `levels` LadderLevel[] — List of levels associated with the Scorecard
      - `level` CurrentLevel
        - `name` string, required — Name of the level
        - `number` integer, required — Rank of the level where 1 is the highest
    - `name` string, required — Human-readable name
    - `notifications` Notifications, required — Notification settings for the Scorecard
      - `enabled` boolean, required — Whether this Scorecard should be included in notifications. If not set, it defaults to true for non-draft Scorecards and to false for draft Scorecards
      - `scoreDropNotificationsEnabled` boolean, required — Whether to notify when an entities' score drops after a Scorecard evaluation. If not set, it defaults to false
    - `rules` ScorecardRule[], required — List of rules that are evaluated each time the Scorecard is evaluated
      - `description` string
      - `effectiveFrom` string, date-time — Date when the rule starts being evaluated
      - `expression` string, required — CQL representation of the rule
      - `failureMessage` string
      - `filter` Filter — Filter applied to the Initiative
        - `groups` GroupFilter — Entity groups to include or exclude
          - `exclude` string[]
          - `include` string[]
        - `query` string — CQL expression to apply as a filter
        - `types` TypeFilter — Entity types (e.g. service, domain, team) to include or exclude. Only one of `include` or `exclude` can be set
          - `exclude` string[]
          - `include` string[]
      - `identifier` string — Unique identifier of the rule
      - `levelName` string — Name of the level this rule is associated with, if applicable
      - `title` string
      - `weight` number — Numerical weight of the rule. When using levels, this defaults to 1
    - `tag` string, required — Unique identifier, found in the UI
  - `total` integer, required — Total number of results
  - `totalPages` integer, required — Total number of pages

## Other responses

- `429` — The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

---

[API](https://skmtc.dev/cortex/apis/cortex-api.md) · [All operations](https://skmtc.dev/cortex/apis/cortex-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cortex/cortex-api/revisions/141799a965b4/schema)